kallithea Files · docs/usage/debugging.rst

Files @ 228dd29e79da

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

domruf

less: clean up changelog style

- use table-layout: fixed
Since we already use a fixed width for the most cells, this makes it easier
(faster) for the browser to render specially big tables.
And it allows to use 'text-overflow: ellipsis'. The old ellipsis settings
have no effect.

- use nowrap and 'text-overflow: ellipsis' for all cells
A table is easier (faster) to read for a user if all the row have the same height.
Therefore don't wrap lines and in case of overflow use ellipsis.

- remove unnecessary height
Up until now the row was bigger then 31px so this had no effect.
And it look wrong to make the row bigger then its content.

- remove unnecessary border-color
bootstrap default is almost the same color

- remove unnecessary text-align
left is the default

- remove font-size or use bootstrap .small
Making fonts too small hurts the readability.

- remove some padding and margin

- don't use special colors
The differences are hardly noticable or in case of the gray dates hurt readability.

- remove obsolete table#changesets .logtags style

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