Mercurial > p > roundup > code
changeset 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 | 378fc1ecaaa6 |
| children | 477f2a47cbca |
| files | CHANGES.txt doc/debugging.txt doc/developers.txt |
| diffstat | 3 files changed, 15 insertions(+), 34 deletions(-) [+] |
line wrap: on
line diff
--- a/CHANGES.txt Mon Apr 19 03:56:54 2010 +0000 +++ b/CHANGES.txt Mon May 10 07:08:11 2010 +0000 @@ -12,6 +12,7 @@ - frontends/roundup.cgi got out of sync with the roundup.cgi.Client API - Default to "text/plain" if no Content-Type header is present in email (thanks Hauke Duden) +- Small documentation update regarding debugging aids (Bernhard Reiter) 2010-02-23 1.5.0
--- a/doc/debugging.txt Mon Apr 19 03:56:54 2010 +0000 +++ b/doc/debugging.txt Mon May 10 07:08:11 2010 +0000 @@ -1,31 +1,23 @@ -Debugging Flags ---------------- +Debugging Aids +-------------- -Roundup uses a number of debugging environment variables to help you -figure out what the heck it's doing. - -HYPERDBDEBUG -============ +Try turning on logging of DEBUG level messages. This may be done a number +of ways, depending on what it is you're testing: -This environment variable should be set to a filename - the hyperdb will -write debugging information for various events (including, for instance, -the SQL used). +1. If you're testing the database unit tests, then set the environment + variable ``LOGGING_LEVEL=DEBUG``. This may be done like so: -This is only obeyed when python is _not_ running in -O mode. + LOGGING_LEVEL=DEBUG python run_tests.py -HYPERDBTRACE -============ + This variable replaces the older HYPERDBDEBUG environment var. -This environment variable should be set to a filename - the hyperdb will -write a timestamp entry for various events. This appears to be suffering -rather extreme bit-rot and may go away soon. - -This is only obeyed when python is _not_ running in -O mode. +2. If you're testing a particular tracker, then set the logging level in + your tracker's ``config.ini``. SENDMAILDEBUG ============= -Set to a filename and roundup will write a copy of each email message -that it sends to that file. This environment variable is independent of -the python -O flag. +Set to a filename and roundup will write each email message +that it sends to that file instead to the internet. +This environment variable is independent of the python -O flag.
--- a/doc/developers.txt Mon Apr 19 03:56:54 2010 +0000 +++ b/doc/developers.txt Mon May 10 07:08:11 2010 +0000 @@ -97,19 +97,7 @@ Debugging Aids -------------- -Try turning on logging of DEBUG level messages. This may be done a number -of ways, depending on what it is you're testing: - -1. If you're testing the database unit tests, then set the environment - variable ``LOGGING_LEVEL=DEBUG``. This may be done like so: - - LOGGING_LEVEL=DEBUG python run_tests.py - - This variable replaces the older HYPERDBDEBUG environment var. - -2. If you're testing a particular tracker, then set the logging level in - your tracker's ``config.ini``. - +See `debugging.txt`_. Internationalization Notes --------------------------