kallithea Files · docs/usage/debugging.rst

Files @ 4077ea3ff4f2

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

Thomas De Schampheleire

tests: vcs: split off repo creation helpers

test_changesets.py needs to create a repository, and is currently
duplicating some of the base setup code.

Instead, split out the setup_class method to allow reuse.

Note that the repo_path variable previously registered to 'self' is not
actually used by anyone, and moreover is not actually necessary as the path
can be obtained via the repo object too. Therefore, just make it a local
variable.

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