From 28a0438400d0b4af65f45ecbb2f1be9119c8e3e5 Mon Sep 17 00:00:00 2001 From: ber Date: Mon, 10 May 2010 07:08:11 +0000 Subject: [PATCH] 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. git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/roundup/trunk@4483 57a73879-2fb5-44c3-a270-3262357dd7e2 --- CHANGES.txt | 1 + doc/debugging.txt | 34 +++++++++++++--------------------- doc/developers.txt | 14 +------------- 3 files changed, 15 insertions(+), 34 deletions(-) diff --git a/CHANGES.txt b/CHANGES.txt index 5173676..29bb127 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -12,6 +12,7 @@ Fixed: - 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 diff --git a/doc/debugging.txt b/doc/debugging.txt index 52b37cc..88379bd 100644 --- a/doc/debugging.txt +++ b/doc/debugging.txt @@ -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. +Try turning on logging of DEBUG level messages. This may be done a number +of ways, depending on what it is you're testing: -HYPERDBDEBUG -============ +1. If you're testing the database unit tests, then set the environment + variable ``LOGGING_LEVEL=DEBUG``. This may be done like so: -This environment variable should be set to a filename - the hyperdb will -write debugging information for various events (including, for instance, -the SQL used). + LOGGING_LEVEL=DEBUG python run_tests.py -This is only obeyed when python is _not_ running in -O mode. + This variable replaces the older HYPERDBDEBUG environment var. -HYPERDBTRACE -============ - -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. diff --git a/doc/developers.txt b/doc/developers.txt index cf26b2d..cc2dee2 100644 --- a/doc/developers.txt +++ b/doc/developers.txt @@ -97,19 +97,7 @@ directions that have not been agreed to. 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 -------------------------- -- 2.30.2