kallithea Files · docs/usage/debugging.rst

Files @ b8deb93894ea

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

Thomas De Schampheleire

model/scm: fix incorrect reporting of pull from remote git repo

In issue #327 it was reported that the pull of a remote git repo causes the
following inaccurate journal entry:
"committed via Kallithea into repository"

The problem is caused by the following flow:

1. pull_changes calls _handle_push for git repos, passing
action='push_remote'.

2. _handle_push calls _handle_rc_scm_extras, but does not pass 'action'

3. _handle_rc_scm_extras uses a default value of 'push_local' for action.

4. The action string 'push_local' will result in the mentioned journal
entry, via action_map in action_parser() (kallithea/lib/helpers.py).

To get a more accurate log entry, _handle_push should pass the action that
it got from pull_changes. In that case, the log entry will become
"pulled from remote into repository"

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