kallithea Files · docs/usage/debugging.rst

Files @ 7c917e15c045

Branch filter:

Location: kallithea/docs/usage/debugging.rst

7c917e15c045 1.2 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

Mads Kiilerich

pullrequests: when creating, don't convert selected revision to tag name

It kind of makes sense that if a branch head or bookmarked revision is chosen,
then pretend the symbolic name was chosen. The name can move and will give the
PR a future. That is currently done both when populating the select boxes and
when actually creating the new PR. There, a selected revision is also
"upgraded" to its branch.

Tags are however mostly static. Fair enough if a user wants to create a PR from
a tag, but if a revision is selected, it shouldn't be side tracked to the tag name.

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