Skip to content

Commit cb154c1

Browse files
author
Richard Jones
committed
Move around some option groupings as I see them.
The charset option is used in contexts other than nosy, so it belongs in the general mail group.
1 parent 7a24d13 commit cb154c1

File tree

1 file changed

+19
-20
lines changed

1 file changed

+19
-20
lines changed

roundup/configuration.py

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Roundup Issue Tracker configuration support
22
#
3-
# $Id: configuration.py,v 1.7 2004-07-25 15:22:54 a1s Exp $
3+
# $Id: configuration.py,v 1.8 2004-07-26 00:23:16 richard Exp $
44
#
55
__docformat__ = "restructuredtext"
66

@@ -377,6 +377,8 @@ class NullableFilePathOption(NullableOption, FilePathOption):
377377
# is a sequence containing class name and constructor
378378
# parameters, starting from the setting name:
379379
# setting, default, [description, [aliases]]
380+
# Note: aliases should only exist in historical options for backwards
381+
# compatibility - new options should *not* have aliases!
380382
SETTINGS = (
381383
("main", (
382384
(FilePathOption, "database", "db", "Database directory path"),
@@ -453,12 +455,6 @@ class NullableFilePathOption(NullableOption, FilePathOption):
453455
"If above 'config' option is set, this option has no effect.\n"
454456
"Allowed values: DEBUG, INFO, WARNING, ERROR"),
455457
)),
456-
# XXX This section covers two service areas:
457-
# outgoing mail (domain, smtp parameters)
458-
# and creation of issues from incoming mail.
459-
# These things should be separated.
460-
# In addition, 'charset' option is used in nosy messages only,
461-
# so this option actually belongs to the 'nosy' section.
462458
("mail", (
463459
(Option, "domain", NODEFAULT, "Domain name used for email addresses."),
464460
(Option, "host", NODEFAULT,
@@ -477,32 +473,35 @@ class NullableFilePathOption(NullableOption, FilePathOption):
477473
(NullableFilePathOption, "tls_certfile", "",
478474
"If TLS is used, you may set this option to the name\n"
479475
"of a PEM formatted certificate chain file"),
476+
(Option, "charset", "utf-8",
477+
"Character set to encode email headers with.\n"
478+
"We use utf-8 by default, as it's the most flexible.\n"
479+
"Some mail readers (eg. Eudora) can't cope with that,\n"
480+
"so you might need to specify a more limited character set\n"
481+
"(eg. iso-8859-1)",
482+
["EMAIL_CHARSET"]),
483+
(FilePathOption, "debug", "",
484+
"Setting this option makes Roundup to write all outgoing email\n"
485+
"messages to this file *instead* of sending them.\n"
486+
"This option has the same effect as environment variable"
487+
" SENDMAILDEBUG.\nEnvironment variable takes precedence."),
488+
)),
489+
("mailgw", (
480490
(BooleanOption, "keep_quoted_text", "yes",
481491
"Keep email citations when accepting messages.\n"
482492
"Setting this to \"no\" strips out \"quoted\" text"
483493
" from the message.\n"
484494
"Signatures are also stripped.",
485495
["EMAIL_KEEP_QUOTED_TEXT"]),
486-
(FilePathOption, "debug", "",
487-
"Setting this option makes Roundup to write all outgoing email\n"
488-
"messages to this file *instead* of sending them.\n"
489-
"This option has the same effect as environment variable"
490-
" SENDMAILDEBUG.\nEnvironment variable takes precedence."),
491496
(BooleanOption, "leave_body_unchanged", "no",
492497
"Preserve the email body as is - that is,\n"
493498
"keep the citations _and_ signatures.",
494499
["EMAIL_LEAVE_BODY_UNCHANGED"]),
495500
(Option, "default_class", "issue",
496501
"Default class to use in the mailgw\n"
497502
"if one isn't supplied in email subjects.\n"
498-
"To disable, leave the value blank."),
499-
(Option, "charset", "utf-8",
500-
"Character set to encode email headers with.\n"
501-
"We use utf-8 by default, as it's the most flexible.\n"
502-
"Some mail readers (eg. Eudora) can't cope with that,\n"
503-
"so you might need to specify a more limited character set\n"
504-
"(eg. iso-8859-1)",
505-
["EMAIL_CHARSET"]),
503+
"To disable, leave the value blank.",
504+
["MAIL_DEFAULT_CLASS"]),
506505
)),
507506
("nosy", (
508507
(BooleanOption, "messages_to_author", "no",

0 commit comments

Comments
 (0)