Files @ 9a69885497b5
Branch filter:

Location: kallithea/docs/usage/debugging.rst - annotation

9a69885497b5 1.2 KiB text/prs.fallenstein.rst Show Source Show as Raw Download as Raw
Thomas De Schampheleire
issues: add more tests and restructure

Add two test cases using the default issue pattern from the ini file
template prior to commit 9cef5615da7b, and some more cases, some of which
verify the behavior regarding test cases with mandatory/optional leading
whitespace.

Increase readability by grouping tests with the same issue pattern, server
and prefix, and place the urlified result on a separate line from the input,
wrapped in case there are multiple issues in the input.

For the result, """ string delimiters are used instead of ' as used in the
input, to visually distinguish them better.
.. _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.