annotate doc/debugging.txt @ 6589:5ce396880899

Add error templates for 400 and label each item optional Added documenttion on adding a _generic.400.html template which can be used to display errors in FTS query syntax. It can include the chrome supplied by page.html which makes navigating etc. easier. Also labeled each section title in the current release optional as none of them are required upgrades. If we add a required step that will break a tracker if not done, it should be labeled required and put at the top of the upgrading section.
author John Rouillard <rouilj@ieee.org>
date Mon, 24 Jan 2022 21:16:30 -0500
parents a635a60ffb84
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4377
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
1 Debugging Aids
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
2 --------------
1836
94e430ad4fdb make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
3
4377
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
4 Try turning on logging of DEBUG level messages. This may be done a number
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
5 of ways, depending on what it is you're testing:
1836
94e430ad4fdb make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
6
4377
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
7 1. If you're testing the database unit tests, then set the environment
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
8 variable ``LOGGING_LEVEL=DEBUG``. This may be done like so:
1836
94e430ad4fdb make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
9
6297
a635a60ffb84 Remove standalone pytest run_tests.py bundle
John Rouillard <rouilj@ieee.org>
parents: 4377
diff changeset
10 LOGGING_LEVEL=DEBUG python -m pytest test/
1836
94e430ad4fdb make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
11
4377
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
12 This variable replaces the older HYPERDBDEBUG environment var.
1836
94e430ad4fdb make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
13
4377
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
14 2. If you're testing a particular tracker, then set the logging level in
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
15 your tracker's ``config.ini``.
1836
94e430ad4fdb make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
16
94e430ad4fdb make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
17 SENDMAILDEBUG
94e430ad4fdb make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
18 =============
94e430ad4fdb make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
19
4377
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
20 Set to a filename and roundup will write each email message
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
21 that it sends to that file instead to the internet.
b6f1aaba4827 Small documentation update regarding debugging aids:
Bernhard Reiter <Bernhard.Reiter@intevation.de>
parents: 1836
diff changeset
22 This environment variable is independent of the python -O flag.
1836
94e430ad4fdb make the RDBMS common backend and the SQLite and MYsql backend create...
Anthony Baxter <anthonybaxter@users.sourceforge.net>
parents:
diff changeset
23

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