Files @ 96c86063278c
Branch filter:

Location: kallithea/docs/usage/debugging.rst

96c86063278c 1.2 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw
Thomas De Schampheleire
autocomplete: also match on email address

There are cases where the firstname/lastname known to Kallithea, is not
complete, perhaps only an initial. But users that try to add a reviewer, may
start typing a full name and expect autocompletion.

For example:

firstname: John
lastname: D
email: john.doe@example.com

When a review starts typing 'Doe' they will not get any matches if
autocompletion is purely based on names.

This situation sometimes arises with Indian developers, where the names
known to companies may be abbreviated as initials. For example "C K Deepak"
where Deepak is the first name and C K are the initials of the last name.
.. _debugging:

===================
Debugging Kallithea
===================

If you encounter problems with Kallithea, here are some instructions
on how to debug them.

.. note:: First make sure you're using the latest version available.


Enable detailed debug
---------------------

Kallithea uses the standard Python ``logging`` module to log its output.
By default only loggers with ``INFO`` level are displayed. To enable full output
change ``level = DEBUG`` for all logging handlers in the currently used .ini file.
This change will allow you to see much more detailed output in the log file or
console. This generally helps a lot to track issues.


Enable interactive debug mode
-----------------------------

To enable interactive debug mode simply comment out ``set debug = false`` in
the .ini file. This will trigger an interactive debugger each time
there is an error in the browser, or send a http link if an error occurred in the backend. This
is a great tool for fast debugging as you get a handy Python console right
in the web view.

.. warning:: NEVER ENABLE THIS ON PRODUCTION! The interactive console
             can be a serious security threat to your system.