Mercurial > p > roundup > code
comparison 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 |
comparison
equal
deleted
inserted
replaced
| 7321:e21c7fe0b57a | 7322:485cecfba982 |
|---|---|
| 162 attached to an issue in our tracker are preferred. | 162 attached to an issue in our tracker are preferred. |
| 163 | 163 |
| 164 Debugging Aids | 164 Debugging Aids |
| 165 -------------- | 165 -------------- |
| 166 | 166 |
| 167 See :doc:`debugging <debugging>`. | 167 Try turning on logging of DEBUG level messages. This may be done a number |
| 168 of ways, depending on what it is you're testing: | |
| 169 | |
| 170 1. If you're testing the database unit tests, then set the environment | |
| 171 variable ``LOGGING_LEVEL=DEBUG``. This may be done like so: | |
| 172 | |
| 173 LOGGING_LEVEL=DEBUG python -m pytest test/ | |
| 174 | |
| 175 This variable replaces the older HYPERDBDEBUG environment var. | |
| 176 | |
| 177 2. If you're testing a particular tracker, then set the logging level in | |
| 178 your tracker's ``config.ini``. | |
| 179 | |
| 180 If you set the environment variable SENDMAILDEBUG to a filename, | |
| 181 roundup will write each email message that it sends to that file | |
| 182 instead to the internet. This environment variable is independent of | |
| 183 the python -O flag. | |
| 184 | |
| 168 | 185 |
| 169 Internationalization Notes | 186 Internationalization Notes |
| 170 -------------------------- | 187 -------------------------- |
| 171 | 188 |
| 172 How stuff works: | 189 How stuff works: |
