kallithea Files · docs/usage/debugging.rst

Files @ 2d6ec8b9b633

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

Thomas De Schampheleire

email templates: reorder references to pullrequests

The current references to PRs in email templates are:

Pull request from <repo> branch <branch> to <repo> branch <branch>:
<niceid> <title> by <user>

as the first line can become very long and therefore hard to read, a first
step is to introduce a newline before the destination branch:

Pull request from <repo> branch <branch>
to <repo> branch <branch>:
<niceid> <title> by <user>

But it would be nicer if the from/to part aligns more.
Moreover, the most useful part is (hopefully) the PR title, the from/to is
secondary and can sometimes even be inferred from the title and context the
recipient is already aware of.

Thus, this commit proposes the following format:

Pull request <niceid> <title> by <user>
from <repo> branch <branch>
to <repo> branch <branch>

This adds some divergence with the changeset references, which could be
aligned later if desired.

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