Skip to content

Commit 90d7b4d

Browse files
Bernhard ReiterBernhard Reiter
authored andcommitted
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.
1 parent 2008575 commit 90d7b4d

File tree

3 files changed

+15
-34
lines changed

3 files changed

+15
-34
lines changed

CHANGES.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Fixed:
1212
- frontends/roundup.cgi got out of sync with the roundup.cgi.Client API
1313
- Default to "text/plain" if no Content-Type header is present in email
1414
(thanks Hauke Duden)
15+
- Small documentation update regarding debugging aids (Bernhard Reiter)
1516

1617

1718
2010-02-23 1.5.0

doc/debugging.txt

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,23 @@
1-
Debugging Flags
2-
---------------
1+
Debugging Aids
2+
--------------
33

4-
Roundup uses a number of debugging environment variables to help you
5-
figure out what the heck it's doing.
4+
Try turning on logging of DEBUG level messages. This may be done a number
5+
of ways, depending on what it is you're testing:
66

7-
HYPERDBDEBUG
8-
============
7+
1. If you're testing the database unit tests, then set the environment
8+
variable ``LOGGING_LEVEL=DEBUG``. This may be done like so:
99

10-
This environment variable should be set to a filename - the hyperdb will
11-
write debugging information for various events (including, for instance,
12-
the SQL used).
10+
LOGGING_LEVEL=DEBUG python run_tests.py
1311

14-
This is only obeyed when python is _not_ running in -O mode.
12+
This variable replaces the older HYPERDBDEBUG environment var.
1513

16-
HYPERDBTRACE
17-
============
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.
14+
2. If you're testing a particular tracker, then set the logging level in
15+
your tracker's ``config.ini``.
2416

2517
SENDMAILDEBUG
2618
=============
2719

28-
Set to a filename and roundup will write a copy of each email message
29-
that it sends to that file. This environment variable is independent of
30-
the python -O flag.
20+
Set to a filename and roundup will write each email message
21+
that it sends to that file instead to the internet.
22+
This environment variable is independent of the python -O flag.
3123

doc/developers.txt

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -97,19 +97,7 @@ directions that have not been agreed to.
9797
Debugging Aids
9898
--------------
9999

100-
Try turning on logging of DEBUG level messages. This may be done a number
101-
of ways, depending on what it is you're testing:
102-
103-
1. If you're testing the database unit tests, then set the environment
104-
variable ``LOGGING_LEVEL=DEBUG``. This may be done like so:
105-
106-
LOGGING_LEVEL=DEBUG python run_tests.py
107-
108-
This variable replaces the older HYPERDBDEBUG environment var.
109-
110-
2. If you're testing a particular tracker, then set the logging level in
111-
your tracker's ``config.ini``.
112-
100+
See `debugging.txt`_.
113101

114102
Internationalization Notes
115103
--------------------------

0 commit comments

Comments
 (0)