Mercurial > kallithea

annotate docs/usage/debugging.rst @ 7570:5b841d56bf74

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
i18n: how_to: add instructions to regenerate translations The wrap value of '76' is determined empirically by checking the total diff after regeneration using wrap values 70 - 90, using 'wc' to find the smallest delta. It also corresponds with the help text of Weblate that says that the default is to 'wrap at 77 characters'.
author Thomas De Schampheleire <thomas.de_schampheleire@nokia.com>
date Tue, 12 Mar 2019 21:22:43 +0100
parents 87ac42db389c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2119
4d076981a7b1 docs about debugging
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
1 .. _debugging:
4d076981a7b1 docs about debugging
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
2
4d076981a7b1 docs about debugging
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
3 ===================
4192
e73a69cb98dc Rename some strings examples and commands in documentation
Bradley M. Kuhn <bkuhn@sfconservancy.org>
parents: 3224
diff changeset
4 Debugging Kallithea
2119
4d076981a7b1 docs about debugging
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
5 ===================
4d076981a7b1 docs about debugging
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
6
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
7 If you encounter problems with Kallithea, here are some instructions
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
8 on how to debug them.
2119
4d076981a7b1 docs about debugging
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
9
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
10 .. note:: First make sure you're using the latest version available.
2119
4d076981a7b1 docs about debugging
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
11
5433
fbbe80e3322b docs: consistent spacing around headings
Mads Kiilerich <madski@unity3d.com>
parents: 4955
diff changeset
12
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4192
diff changeset
13 Enable detailed debug
2119
4d076981a7b1 docs about debugging
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
14 ---------------------
4d076981a7b1 docs about debugging
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
15
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
16 Kallithea uses the standard Python ``logging`` module to log its output.
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
17 By default only loggers with ``INFO`` level are displayed. To enable full output
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
18 change ``level = DEBUG`` for all logging handlers in the currently used .ini file.
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
19 This change will allow you to see much more detailed output in the log file or
2125
097327aaf2ad more detailed logging on auth system
Marcin Kuzminski <marcin@python-works.com>
parents: 2119
diff changeset
20 console. This generally helps a lot to track issues.
2119
4d076981a7b1 docs about debugging
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
21
4d076981a7b1 docs about debugging
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
22
4902
03bbd33bc084 docs: rework stuff
Mads Kiilerich <madski@unity3d.com>
parents: 4192
diff changeset
23 Enable interactive debug mode
2119
4d076981a7b1 docs about debugging
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
24 -----------------------------
4d076981a7b1 docs about debugging
Marcin Kuzminski <marcin@python-works.com>
parents:
diff changeset
25
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
26 To enable interactive debug mode simply comment out ``set debug = false`` in
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
27 the .ini file. This will trigger an interactive debugger each time
5854
87ac42db389c spelling: occurred
timeless@gmail.com
parents: 5433
diff changeset
28 there is an error in the browser, or send a http link if an error occurred in the backend. This
4955
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
29 is a great tool for fast debugging as you get a handy Python console right
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
30 in the web view.
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
31
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
32 .. warning:: NEVER ENABLE THIS ON PRODUCTION! The interactive console
4e6dfdb3fa01 docs: English and consistency corrections
Michael V. DePalatis <mike@depalatis.net>
parents: 4902
diff changeset
33 can be a serious security threat to your system.