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

diff --git a/CHANGES.txt b/CHANGES.txt
index 517367656465208dea7124f2d758af4fac100ce7..29bb12738d2510ee6364d07381d228a2348635d9 100644 (file)
--- 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 52b37cc52c64de35d299aa8ca32302d1ebc6d48a..88379bda7b3c7db1de30f14cb13aad2bef09d41a 100644 (file)
--- 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 cf26b2ddc2ec31a42bcda208668d5f05321d3c7a..cc2dee28cd52d7808a63f60663e773e1548f6a0e 100644 (file)
--- 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
 --------------------------