kallithea Files · docs/usage/debugging.rst

Files @ a42ab217f3d0

Branch filter:

Location: kallithea/docs/usage/debugging.rst

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

mads

front-end: add eslint-plugin-html as dependency as introduced in .eslintrc.js in 4d36432bf705

Usage example:
hg up -cr.
sed -i -e 's/\${[^{}]*${[^{}]*}[^{}]*$*}/""/g' -e 's/%$if\|else\|endif\|for\|endfor$\>.*//g' -e 's/##.*//g' $(hg loc 'kallithea/templates/**.html')
vim kallithea/templates/pullrequests/pullrequest.html +139 # blank out the multi line 'var url = ${}'
( cd kallithea/front-end/ && node_modules/.bin/eslint $(hg loc 'kallithea/templates/**.html')) | tee l
hg up -Cr.

( sed -n 's/^function $[^(]*$.*/\1/gp' kallithea/public/js/base.js; sed -n 's/.* var $[^ ]*$ =.*/\1/p' kallithea/templates/base/root.html; echo pyroutes; echo CodeMirror; echo Select2; echo BranchRenderer;)|while read x; do echo $x; sed -i "/error .$x. is not defined /d" l; done; cat l

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