Mercurial > p > roundup > code
annotate doc/security.txt @ 7371:a210f4437b49
Incomplete work to generate config doc from config.ini
This is an incomplete attempt to allow generation of the config.ini
documentation in reference.txt. It reformats the output of
'roundup_admin.py genconfig'. So it now includes all of the
settings. Using a Makefile rule like:
tracker_config.txt: ../roundup/configuration.py
python3 ../roundup/scripts/roundup_admin.py \
genconfig _temp_config.txt
sed -e '1,8d' \
-e 's/^\[\([a-z]*\)\]/\n.. index:: config.ini; sections \1\n\n.. code:: ini\n\n [\1]/' \
-e 's/^\([^[]\)/ \1/' \
_temp_config.txt > tracker_config.txt
rm -f _temp_config.txt
results in the config.ini split by section and index links being put
in place. However some sections have a comment before the [section]
marker. This comment is orphaned at the end of the prior section
rather than starting the new section. A simple sed won't allow the
lookahead needed to target the [section] marker and include the prior
comment block. Also there are still have some long lines generated (>
65 characters). Maybe a python script can import configuration.py and
output proper restructured text output?
reference.txt:
add a commented out include:: tracker_config.txt directive
roundup/admin.py:
don't require a tracker home for genconfig. So user can generate a
clean config.ini on demand. Tracker home is still required for
updateconfig.
roundup/configuration.py:
wrap lines better. A number of them are generating comments > 65
characters which is the targeted line length. This cleans up
config.ini too, so is a good thing.
website/www/conf.py:
ignore doc/tracker_config.ini when processing.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Wed, 17 May 2023 13:34:36 -0400 |
| parents | a3223f1966fc |
| children | 186956a87ad7 |
| rev | line source |
|---|---|
| 7092 | 1 .. meta:: |
| 2 :description: | |
| 3 Documentation on how to report security issues with | |
| 4 Roundup. Also index to security related portions in other | |
| 5 Roundup documentation. | |
| 6 | |
| 7 .. index:: | |
| 8 single: Reporting Security Issues | |
| 9 single: Security Issues, Reporting | |
| 10 | |
| 11 | |
| 12 ====================================== | |
| 13 Reporting Security Issues with Roundup | |
| 14 ====================================== | |
| 15 | |
| 16 Security issues with Roundup should be reported by email to: | |
| 17 | |
| 18 rouilj@users.sourceforge.net (John Rouillard) | |
| 19 | |
|
7099
a3223f1966fc
update to use ralf's preferred email address.
John Rouillard <rouilj@ieee.org>
parents:
7095
diff
changeset
|
20 rsc@runtux.com (Ralf Schlatterbeck) |
| 7092 | 21 |
| 22 Also you can find rouilj on irc in channel #roundup at irc.oftc.net (see | |
| 23 Contact_ for more directions and web interface). | |
| 24 | |
| 25 Use these mechanisms to establish initial contact. | |
| 26 | |
| 27 .. _Contact: https://www.roundup-tracker.org/contact.html |
