comparison doc/debugging.txt @ 4377:b6f1aaba4827

Small documentation update regarding debugging aids: - doc/debugging.txt: removed HYPERDBDEBUG and HYPERDBTRACE and replaced it with the text for SENDMAILDEBUG from doc/developers.txt. A short code inspection showed that to be correct. - refered to debugging.txt from developers.txt to have one unique place for documenting debugging aids. - Clarified for SENDMAILDEBUG that no email will be send if it is set.
author Bernhard Reiter <Bernhard.Reiter@intevation.de>
date Mon, 10 May 2010 07:08:11 +0000
parents 94e430ad4fdb
children a635a60ffb84
comparison
equal deleted inserted replaced
4375:378fc1ecaaa6 4377:b6f1aaba4827
1 Debugging Flags 1 Debugging Aids
2 --------------- 2 --------------
3 3
4 Roundup uses a number of debugging environment variables to help you 4 Try turning on logging of DEBUG level messages. This may be done a number
5 figure out what the heck it's doing. 5 of ways, depending on what it is you're testing:
6 6
7 HYPERDBDEBUG 7 1. If you're testing the database unit tests, then set the environment
8 ============ 8 variable ``LOGGING_LEVEL=DEBUG``. This may be done like so:
9 9
10 This environment variable should be set to a filename - the hyperdb will 10 LOGGING_LEVEL=DEBUG python run_tests.py
11 write debugging information for various events (including, for instance,
12 the SQL used).
13 11
14 This is only obeyed when python is _not_ running in -O mode. 12 This variable replaces the older HYPERDBDEBUG environment var.
15 13
16 HYPERDBTRACE 14 2. If you're testing a particular tracker, then set the logging level in
17 ============ 15 your tracker's ``config.ini``.
18
19 This environment variable should be set to a filename - the hyperdb will
20 write a timestamp entry for various events. This appears to be suffering
21 rather extreme bit-rot and may go away soon.
22
23 This is only obeyed when python is _not_ running in -O mode.
24 16
25 SENDMAILDEBUG 17 SENDMAILDEBUG
26 ============= 18 =============
27 19
28 Set to a filename and roundup will write a copy of each email message 20 Set to a filename and roundup will write each email message
29 that it sends to that file. This environment variable is independent of 21 that it sends to that file instead to the internet.
30 the python -O flag. 22 This environment variable is independent of the python -O flag.
31 23

Roundup Issue Tracker: http://roundup-tracker.org/