Mercurial > p > roundup > code
comparison roundup/configuration.py @ 7920:6aa0525187cd
doc: use generated config.ini in reference.txt
Deleted the manually maintained config.ini reference items.
Lost a few nice index references along the way but...
Updated configuration.py with longer descriptions from the manually
maintained items where appropriate.
Checking in the generated tracker_config.txt and the Makefile used
to generate the config and the man pages and then generate local
documentation using setup.py build_docs.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Mon, 29 Apr 2024 04:17:10 -0400 |
| parents | 82093eb944d6 |
| children | 791b61ed11c9 |
comparison
equal
deleted
inserted
replaced
| 7919:e3b34d02c61a | 7920:6aa0525187cd |
|---|---|
| 1515 (IntegerNumberGeqZeroOption, 'sqlite_timeout', '30', | 1515 (IntegerNumberGeqZeroOption, 'sqlite_timeout', '30', |
| 1516 "Number of seconds to wait when the SQLite database is locked\n" | 1516 "Number of seconds to wait when the SQLite database is locked\n" |
| 1517 "Default: use a 30 second timeout (extraordinarily generous)\n" | 1517 "Default: use a 30 second timeout (extraordinarily generous)\n" |
| 1518 "Only used in SQLite connections."), | 1518 "Only used in SQLite connections."), |
| 1519 (IntegerNumberGeqZeroOption, 'cache_size', '100', | 1519 (IntegerNumberGeqZeroOption, 'cache_size', '100', |
| 1520 "Size of the node cache (in elements)"), | 1520 "Size of the node cache (in elements). Used to keep the\n" |
| 1521 "most recently used data in memory."), | |
| 1521 (BooleanOption, "allow_create", "yes", | 1522 (BooleanOption, "allow_create", "yes", |
| 1522 "Setting this option to 'no' protects the database against\n" | 1523 "Setting this option to 'no' protects the database against\n" |
| 1523 "table creations."), | 1524 "table creations."), |
| 1524 (BooleanOption, "allow_alter", "yes", | 1525 (BooleanOption, "allow_alter", "yes", |
| 1525 "Setting this option to 'no' protects the database against\n" | 1526 "Setting this option to 'no' protects the database against\n" |
| 1601 "Set this if your mail host requires authenticated access."), | 1602 "Set this if your mail host requires authenticated access."), |
| 1602 (IntegerNumberGeqZeroOption, "port", smtplib.SMTP_PORT, | 1603 (IntegerNumberGeqZeroOption, "port", smtplib.SMTP_PORT, |
| 1603 "Default port to send SMTP on.\n" | 1604 "Default port to send SMTP on.\n" |
| 1604 "Set this if your mail server runs on a different port."), | 1605 "Set this if your mail server runs on a different port."), |
| 1605 (NullableOption, "local_hostname", '', | 1606 (NullableOption, "local_hostname", '', |
| 1606 "The local hostname to use during SMTP transmission.\n" | 1607 "The (fully qualified) host/ domain name (FQDN) to use during\n" |
| 1607 "Set this if your mail server requires something specific."), | 1608 "SMTP sessions. If left blank, the underlying SMTP library will\n" |
| 1609 "attempt to detect your FQDN. Set this if your mail server\n" | |
| 1610 "requires something specific.\n"), | |
| 1608 (BooleanOption, "tls", "no", | 1611 (BooleanOption, "tls", "no", |
| 1609 "If your SMTP mail host provides or requires TLS\n" | 1612 "If your SMTP mail host provides or requires TLS\n" |
| 1610 "(Transport Layer Security) then set this option to 'yes'."), | 1613 "(Transport Layer Security) then set this option to 'yes'."), |
| 1611 (NullableFilePathOption, "tls_keyfile", "", | 1614 (NullableFilePathOption, "tls_keyfile", "", |
| 1612 "If TLS is used, you may set this option to the name\n" | 1615 "If TLS is used, you may set this option to the name\n" |
| 1634 "at the top of all messages.\n" | 1637 "at the top of all messages.\n" |
| 1635 "If this is false but add_authorinfo is true, only the name\n" | 1638 "If this is false but add_authorinfo is true, only the name\n" |
| 1636 "of the actor is added which protects the mail address of the\n" | 1639 "of the actor is added which protects the mail address of the\n" |
| 1637 "actor from being exposed at mail archives, etc."), | 1640 "actor from being exposed at mail archives, etc."), |
| 1638 ), "Outgoing email options.\n" | 1641 ), "Outgoing email options.\n" |
| 1639 "Used for nosy messages and approval requests"), | 1642 "Used for nosy messages, password reset and registration approval\n" |
| 1643 "requests."), | |
| 1640 ("mailgw", ( | 1644 ("mailgw", ( |
| 1641 (EmailBodyOption, "keep_quoted_text", "yes", | 1645 (EmailBodyOption, "keep_quoted_text", "yes", |
| 1642 "Keep email citations when accepting messages.\n" | 1646 "Keep email citations when accepting messages.\n" |
| 1643 'Setting this to "no" strips out "quoted" text\n' | 1647 'Setting this to "no" strips out "quoted" text\n' |
| 1644 'from the message. Setting this to "new" keeps quoted\n' | 1648 'from the message. Setting this to "new" keeps quoted\n' |