kallithea Files · docs/usage/debugging.rst

Files @ 5a38b9084a9e

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

domruf

hooks: fix encoding problems of lock release ui messages

The vcs test test_push_unlocks_repository_hg would fail when waitress tried to
append a unicode chunk to the byte stream. The unicode string came from the
'Released lock on repo' message passed to ui.status from the push hook.

ui.status do however follow the Mercurial convention and expects a byte string.

We solve the problem by applying safe_str.

Patch modified by Mads Kiilerich.

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