Files @ f6076c096692
Branch filter:

Location: kallithea/docs/usage/debugging.rst

f6076c096692 1.2 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw
Thomas De Schampheleire
tests: vcs: remove influence of user's hg settings

Certain settings in the user's hgrc file can cause test failures. For
example, enabling a non-existent extension prints stderr messages like

*** failed to import extension journal: No module named journal

Tests that check stderr output for emptiness, like
test_clone_hg_repo_by_admin, then fail.

Instead, avoid all influence of the user's settings, by setting HGRCPATH and
HGPLAIN to empty.

In versions of Mercurial before 4.2, setting an empty HGRCPATH was generally
enough to get expected behavior, but since 4.2 the behavior of some commands
has changed, and a pager is now default. Setting HGPLAIN is a simple way of
neutralizing even that.
.. _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.