kallithea Files · docs/usage/debugging.rst

Files @ b3ef9012be54

Branch filter:

Location: kallithea/docs/usage/debugging.rst

b3ef9012be54 1.2 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

Mads Kiilerich

hg: fix continuation binding of callback variables

The get_file_annotate generator yields a callback. That callback happened to
look at the current state of the generator. It happened to work anyway,
apparently because the callback always was called immediately, before the
generator state changed. But for example if the get_file_annotate was buffered
into a list, the callback would return the same result each time.

Instead, bind the generator iterator variables as named parameter values for
the callback function. That will make sure the callback always returns the
right value.

.. _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.