kallithea Files · docs/usage/debugging.rst

Files @ bec4bc21f845

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

Thomas De Schampheleire

setup.py: bump Pygments minimum version to 2.2.0

With pygments < 2.2.0, the markup_renderer doctest fails:

> python -m doctest kallithea/lib/markup_renderer.py
**********************************************************************
File "kallithea/lib/markup_renderer.py", line 184, in markup_renderer.MarkupRenderer.markdown
Failed example:
print MarkupRenderer.markdown('''
#!/bin/bash
echo "hello"
''')
Expected:
<table class="code-highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1
2</pre></div></td><td class="code"><div class="code-highlight"><pre><span></span><span class="ch">#!/bin/bash</span>
<span class="nb">echo</span> <span class="s2">"hello"</span>
</pre></div>
</td></tr></table>
Got:
<table class="code-highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1
2</pre></div></td><td class="code"><div class="code-highlight"><pre><span class="ch">#!/bin/bash</span>
<span class="nb">echo</span> <span class="s2">"hello"</span>
</pre></div>
</td></tr></table>
**********************************************************************

To avoid having to manage multiple outputs from multiple versions, just bump
the lower version.

pygments 2.2.0 was released on Jan 22, 2017.

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