kallithea Files · docs/usage/debugging.rst

Files @ 85a6526a15a8

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

Thomas De Schampheleire

diff view: do not hide overflow on very long lines that cannot be wrapped

When a change contains very long lines that cannot be wrapped because they
contain very long 'words' without spaces, the overflow is currently not
visible at all. This occurrence of such very long non-wrappable words is
pretty uncommon, but can for example happen in comma-separated value files.

Not touching the existing behavior of trying to wrap long lines, this patch
adds horizontal scrollbars for these exceptional cases of unavoidable
overflow.
On normal lines and long lines that can be wrapped, the diff block remains
the same as before.

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