# HG changeset patch # User John Rouillard # Date 1683827457 14400 # Node ID 485cecfba982a159588b27f93a484426b3ac614c # Parent e21c7fe0b57ac8bfebd3c69d5818d43163c77267 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 Design (original) docs/developers Notes about the MySQL Database backend Notes about the PostgreSQL Database backend Richard Jones implementation notes docs/security-history to keep them out of the docs.txt sidebar. diff -r e21c7fe0b57a -r 485cecfba982 doc/debugging.txt --- a/doc/debugging.txt Thu May 11 13:38:13 2023 -0400 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,23 +0,0 @@ -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 -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``. - -SENDMAILDEBUG -============= - -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 -r e21c7fe0b57a -r 485cecfba982 doc/developers.txt --- 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 `. +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 -------------------------- diff -r e21c7fe0b57a -r 485cecfba982 doc/security-history.txt --- a/doc/security-history.txt Thu May 11 13:38:13 2023 -0400 +++ b/doc/security-history.txt Thu May 11 13:50:57 2023 -0400 @@ -4,9 +4,9 @@ :orphan: -=================== -Security Mechanisms -=================== +============================= +Old Security Mechanisms Notes +============================= Current situation ================= diff -r e21c7fe0b57a -r 485cecfba982 website/www/docs.txt --- a/website/www/docs.txt Thu May 11 13:38:13 2023 -0400 +++ b/website/www/docs.txt Thu May 11 13:50:57 2023 -0400 @@ -16,20 +16,11 @@ docs/FAQ docs/user_guide docs/customizing + docs/rest + docs/xmlrpc docs/reference - docs/admin_guide - docs/security-history - docs/upgrading-history - docs/debugging - docs/xmlrpc - docs/rest - docs/tracker_templates docs/glossary - docs/acknowledgements + docs/admin_guide docs/license - Design Overview - Design (original) - docs/developers - Notes about the MySQL Database backend - Notes about the PostgreSQL Database backend - Richard Jones implementation notes + docs/acknowledgements + olderdocs diff -r e21c7fe0b57a -r 485cecfba982 website/www/olderdocs.txt --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/website/www/olderdocs.txt Thu May 11 13:50:57 2023 -0400 @@ -0,0 +1,20 @@ +Other Docs +========== + +.. toctree:: + :maxdepth: 2 + + docs/upgrading-history + + docs/tracker_templates + + Design Overview + Design (original) + + docs/developers + + Notes about the MySQL Database backend + Notes about the PostgreSQL Database backend + + Richard Jones implementation notes + docs/security-history