diff doc/developers.txt @ 7322:485cecfba982

Simplify TOC; older docs pushed a level down; Consolidate debugging Restructured docs.txt. Pulled out older documents into Old Docs. I wish I could add whitespace between documents in the toc. Current order split into groupings: Roundup Features Roundup Features Installing Roundup Upgrading to newer versions of Roundup Reporting Security Issues with Roundup Roundup FAQ User Guide Customising Roundup REST API for Roundup XML-RPC access to Roundup Roundup Reference Roundup Glossary Administration Guide License Acknowledgements Other Docs debugging.txt removed. Its contents replaced a reference in developer.txt. Added olderdocs for: docs/upgrading-history docs/tracker_templates Design Overview <docs/overview> Design (original) <docs/design> docs/developers Notes about the MySQL Database backend <docs/mysql> Notes about the PostgreSQL Database backend <docs/postgresql> Richard Jones implementation notes <docs/implementation> docs/security-history to keep them out of the docs.txt sidebar.
author John Rouillard <rouilj@ieee.org>
date Thu, 11 May 2023 13:50:57 -0400
parents ff7564af07b1
children beed64c7090c
line wrap: on
line diff
--- a/doc/developers.txt	Thu May 11 13:38:13 2023 -0400
+++ b/doc/developers.txt	Thu May 11 13:50:57 2023 -0400
@@ -164,7 +164,24 @@
 Debugging Aids
 --------------
 
-See :doc:`debugging <debugging>`.
+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 -m pytest test/
+
+   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``.
+
+If you set the environment variable SENDMAILDEBUG to a filename,
+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.
+
 
 Internationalization Notes
 --------------------------

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