kallithea Files · docs/usage/debugging.rst

Files @ 9ff4b82f56c9

Branch filter:

Location: kallithea/docs/usage/debugging.rst

9ff4b82f56c9 1.1 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

Thomas De Schampheleire

date representation: use ISO8601 rather than a specific locale

Dates, in particular in technical systems like Kallithea, are
better shown in a clear concise format like ISO8601 (YYYY-MM-DD)
than in a verbose format like 'Thu, Feb 26 2015'.

This commit changes all dates to ISO8601.

---
If desired, we could create two functions: one that returns ISO format and
another for the locale format. Depending on the usage, one or the other is
shown. I'm not very fond of that though, it looks inconsistent.

.. _debugging:

===================
Debugging Kallithea
===================

If you encountered problems with Kallithea here are some instructions how to
possibly debug them.

** First make sure you're using the latest version available.**

enable detailed debug
---------------------

Kallithea uses standard python logging modules to log it's output.
By default only loggers with INFO level are displayed. To enable full output
change `level = DEBUG` for all logging handlers in currently used .ini file.
This change will allow to see much more detailed output in the logfile 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
.ini file, this will trigger and interactive debugger each time there an
error in browser, or send a http link if 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. ** NEVER ENABLE THIS ON PRODUCTION ** the interactive console
can be a serious security threat to you system.