Abhilash Raj has proposed merging lp:~raj-abhilash1/mailman/mailman_fix into
lp:mailman.
Requested reviews:
Mailman Coders (mailman-coders)
For more details, see:
https://code.launchpad.net/~raj-abhilash1/mailman/mailman_fix/+merge/252774
Change bin/mailman with mailman everwhere in documentation and docstrings.
--
Your team Mailman Coders is requested to review the proposed merge of
lp:~raj-abhilash1/mailman/mailman_fix into lp:mailman.
=== modified file 'src/mailman/bin/docs/master.rst'
--- src/mailman/bin/docs/master.rst 2014-04-28 15:23:35 +0000
+++ src/mailman/bin/docs/master.rst 2015-03-12 16:35:40 +0000
@@ -4,7 +4,7 @@
Mailman has a number of *runner subprocesses* which perform long-running tasks
such as listening on an LMTP port, processing REST API requests, or processing
-messages in a queue directory. In normal operation, the ``bin/mailman``
+messages in a queue directory. In normal operation, the ``mailman``
command is used to start, stop and manage the runners. This is just a wrapper
around the real master watcher, which handles runner starting, stopping,
exiting, and log file reopening.
=== modified file 'src/mailman/bin/mailman.py'
--- src/mailman/bin/mailman.py 2015-01-05 01:22:39 +0000
+++ src/mailman/bin/mailman.py 2015-03-12 16:35:40 +0000
@@ -36,7 +36,7 @@
def main():
- """bin/mailman"""
+ """mailman"""
# Create the basic parser and add all globally common options.
parser = argparse.ArgumentParser(
description=_("""\
=== modified file 'src/mailman/bin/master.py'
--- src/mailman/bin/master.py 2015-01-05 01:22:39 +0000
+++ src/mailman/bin/master.py 2015-03-12 16:35:40 +0000
@@ -320,7 +320,7 @@
log.info('Master watcher caught SIGUSR1. Exiting.')
signal.signal(signal.SIGUSR1, sigusr1_handler)
# SIGTERM is what init will kill this process with when changing run
- # levels. It's also the signal 'bin/mailman stop' uses.
+ # levels. It's also the signal 'mailman stop' uses.
def sigterm_handler(signum, frame):
for pid in self._kids:
os.kill(pid, signal.SIGTERM)
=== modified file 'src/mailman/bin/runner.py'
--- src/mailman/bin/runner.py 2015-01-05 01:22:39 +0000
+++ src/mailman/bin/runner.py 2015-03-12 16:35:40 +0000
@@ -116,7 +116,7 @@
-r is required unless -l or -h is given, and its argument must
be one of the names displayed by the -l switch.
- Normally, this script should be started from 'bin/mailman
+ Normally, this script should be started from 'mailman
start'. Running it separately or with -o is generally useful
only for debugging. When run this way, the environment variable
$MAILMAN_UNDER_MASTER_CONTROL will be set which subtly changes
=== modified file 'src/mailman/commands/cli_inject.py'
--- src/mailman/commands/cli_inject.py 2015-01-05 01:22:39 +0000
+++ src/mailman/commands/cli_inject.py 2015-03-12 16:35:40 +0000
@@ -15,7 +15,7 @@
# You should have received a copy of the GNU General Public License along with
# GNU Mailman. If not, see <http://www.gnu.org/licenses/>.
-"""bin/mailman inject"""
+"""mailman inject"""
__all__ = [
'Inject',
=== modified file 'src/mailman/commands/cli_status.py'
--- src/mailman/commands/cli_status.py 2015-01-05 01:22:39 +0000
+++ src/mailman/commands/cli_status.py 2015-03-12 16:35:40 +0000
@@ -15,7 +15,7 @@
# You should have received a copy of the GNU General Public License along with
# GNU Mailman. If not, see <http://www.gnu.org/licenses/>.
-"""bin/mailman status."""
+"""mailman status."""
__all__ = [
'Status',
=== modified file 'src/mailman/commands/cli_withlist.py'
--- src/mailman/commands/cli_withlist.py 2015-01-05 01:22:39 +0000
+++ src/mailman/commands/cli_withlist.py 2015-03-12 16:35:40 +0000
@@ -15,7 +15,7 @@
# You should have received a copy of the GNU General Public License along with
# GNU Mailman. If not, see <http://www.gnu.org/licenses/>.
-"""bin/mailman withlist"""
+"""mailman withlist"""
__all__ = [
'Shell',
@@ -190,7 +190,7 @@
this script will take care of the housekeeping (see below for examples). In
that case, the general usage syntax is:
- % bin/mailman withlist [options] listname [args ...]"""))
+ % mailman withlist [options] listname [args ...]"""))
print()
print(_("""\
Here's an example of how to use the --run option. Say you have a file in the
@@ -207,7 +207,7 @@
You can print the list's posting address by running the following from the
command line:
- % bin/mailman withlist -r listaddr [email protected]
+ % mailman withlist -r listaddr [email protected]
Importing listaddr ...
Running listaddr.listaddr() ...
[email protected]"""))
@@ -215,7 +215,7 @@
print(_("""\
And you can print the list's request address by running:
- % bin/mailman withlist -r listaddr.requestaddr mylist
+ % mailman withlist -r listaddr.requestaddr mylist
Importing listaddr ...
Running listaddr.requestaddr() ...
[email protected]"""))
@@ -232,7 +232,7 @@
and run this from the command line:
- % bin/mailman withlist -r change [email protected] 'My List'"""))
+ % mailman withlist -r change [email protected] 'My List'"""))
=== modified file 'src/mailman/commands/docs/aliases.rst'
--- src/mailman/commands/docs/aliases.rst 2014-04-28 15:23:35 +0000
+++ src/mailman/commands/docs/aliases.rst 2015-03-12 16:35:40 +0000
@@ -6,7 +6,7 @@
Mailman up to the mail server. The details of this differ for each mail
server. Generally these files are automatically kept up-to-date when mailing
lists are created or removed, but you might occasionally need to manually
-regenerate the file. The ``bin/mailman aliases`` command does this.
+regenerate the file. The ``mailman aliases`` command does this.
>>> class FakeArgs:
... directory = None
=== modified file 'src/mailman/commands/docs/conf.rst'
--- src/mailman/commands/docs/conf.rst 2014-11-08 00:31:21 +0000
+++ src/mailman/commands/docs/conf.rst 2015-03-12 16:35:40 +0000
@@ -2,12 +2,12 @@
Display configuration values
============================
-Just like the `Postfix command postconf(1)`_, the ``bin/mailman conf`` command
+Just like the `Postfix command postconf(1)`_, the ``mailman conf`` command
lets you dump one or more Mailman configuration variables to standard output
or a file.
Mailman's configuration is divided in multiple sections which contain multiple
-key-value pairs. The ``bin/mailman conf`` command allows you to display
+key-value pairs. The ``mailman conf`` command allows you to display
a specific key-value pair, or several key-value pairs.
>>> class FakeArgs:
=== modified file 'src/mailman/commands/docs/members.rst'
--- src/mailman/commands/docs/members.rst 2015-01-05 01:40:47 +0000
+++ src/mailman/commands/docs/members.rst 2015-03-12 16:35:40 +0000
@@ -2,7 +2,7 @@
Managing members
================
-The ``bin/mailman members`` command allows a site administrator to display,
+The ``mailman members`` command allows a site administrator to display,
add, and remove members from a mailing list.
::
=== modified file 'src/mailman/commands/tests/test_create.py'
--- src/mailman/commands/tests/test_create.py 2015-01-05 01:22:39 +0000
+++ src/mailman/commands/tests/test_create.py 2015-03-12 16:35:40 +0000
@@ -15,7 +15,7 @@
# You should have received a copy of the GNU General Public License along with
# GNU Mailman. If not, see <http://www.gnu.org/licenses/>.
-"""Test `bin/mailman create`."""
+"""Test `mailman create`."""
__all__ = [
'TestCreate',
@@ -51,7 +51,7 @@
class TestCreate(unittest.TestCase):
- """Test `bin/mailman create`."""
+ """Test `mailman create`."""
layer = ConfigLayer
=== modified file 'src/mailman/config/config.py'
--- src/mailman/config/config.py 2015-01-06 02:12:52 +0000
+++ src/mailman/config/config.py 2015-03-12 16:35:40 +0000
@@ -149,7 +149,7 @@
# First, collect all variables in a substitution dictionary. $VAR_DIR
# is taken from the environment or from the configuration file if the
# environment is not set. Because the var_dir setting in the config
- # file could be a relative path, and because 'bin/mailman start'
+ # file could be a relative path, and because 'mailman start'
# chdirs to $VAR_DIR, without this subprocesses bin/master and
# bin/runner will create $VAR_DIR hierarchies under $VAR_DIR when that
# path is relative.
=== modified file 'src/mailman/config/schema.cfg'
--- src/mailman/config/schema.cfg 2015-01-05 01:22:39 +0000
+++ src/mailman/config/schema.cfg 2015-03-12 16:35:40 +0000
@@ -66,7 +66,7 @@
[shell]
-# `bin/mailman shell` (also `withlist`) gives you an interactive prompt that
+# `mailman shell` (also `withlist`) gives you an interactive prompt that
# you can use to interact with an initialized and configured Mailman system.
# Use --help for more information. This section allows you to configure
# certain aspects of this interactive shell.
@@ -100,7 +100,7 @@
queue_dir: $var_dir/queue
# This is the directory containing the Mailman 'runner' and 'master' commands
# if set to the string '$argv', it will be taken as the directory containing
-# the 'bin/mailman' command.
+# the 'mailman' command.
bin_dir: $argv
# All list-specific data.
list_data_dir: $var_dir/lists
=== modified file 'src/mailman/core/logging.py'
--- src/mailman/core/logging.py 2015-01-05 01:22:39 +0000
+++ src/mailman/core/logging.py 2015-03-12 16:35:40 +0000
@@ -104,7 +104,7 @@
log_format = logger_config.format
log_datefmt = logger_config.datefmt
# Propagation to the root logger is how we handle logging to stderr
- # when the runners are not run as a subprocess of 'bin/mailman start'.
+ # when the runners are not run as a subprocess of 'mailman start'.
log.propagate = (as_boolean(logger_config.propagate)
if propagate is None else propagate)
# Set the logger's level.
=== modified file 'src/mailman/docs/8-miles-high.rst'
--- src/mailman/docs/8-miles-high.rst 2013-05-14 04:45:26 +0000
+++ src/mailman/docs/8-miles-high.rst 2015-03-12 16:35:40 +0000
@@ -162,7 +162,7 @@
Shell Commands
==============
-`bin/mailman`: This is an ubercommand, with subcommands for all the various
+`mailman`: This is an ubercommand, with subcommands for all the various
things admins might want to do, similar to Mailman 2's mailmanctl, but with
more functionality.
=== modified file 'src/mailman/docs/DEVELOP.rst'
--- src/mailman/docs/DEVELOP.rst 2014-12-22 21:19:01 +0000
+++ src/mailman/docs/DEVELOP.rst 2015-03-12 16:35:40 +0000
@@ -72,10 +72,10 @@
include the LMTP server, and the HTTP server for processing REST commands.
All of the runners are managed by a *master watcher* process. When you type
-``bin/mailman start`` you are actually starting the master. Based on
+``mailman start`` you are actually starting the master. Based on
configuration options, the master will start the appropriate runners as
subprocesses, and it will watch for the clean exiting of these subprocesses
-when ``bin/mailman stop`` is called.
+when ``mailman stop`` is called.
Rules and chains
=== modified file 'src/mailman/docs/MTA.rst'
--- src/mailman/docs/MTA.rst 2014-04-15 14:34:04 +0000
+++ src/mailman/docs/MTA.rst 2015-03-12 16:35:40 +0000
@@ -143,7 +143,7 @@
By default, Mailman works well with Postfix transport maps as a way to deliver
incoming messages to Mailman's LMTP server. Mailman will automatically write
-the correct transport map when its ``bin/mailman aliases`` command is run, or
+the correct transport map when its ``mailman aliases`` command is run, or
whenever a mailing list is created or removed via other commands. To connect
Postfix to Mailman's LMTP server, add the following to Postfix's ``main.cf``
file::
=== modified file 'src/mailman/docs/NEWS.rst'
--- src/mailman/docs/NEWS.rst 2015-02-14 01:35:35 +0000
+++ src/mailman/docs/NEWS.rst 2015-03-12 16:35:40 +0000
@@ -173,7 +173,7 @@
-------------
* Add support for the Exim 4 MTA. [Stephen Turnbull]
* When creating the initial file system layout in ``var``, e.g. via
- ``bin/mailman info``, add an ``var/etc/mailman.cfg`` file if one does not
+ ``mailman info``, add an ``var/etc/mailman.cfg`` file if one does not
already exist. Also, when initializing the system, look for that file as
the configuration file, just after ``./mailman.cfg`` and before
``~/.mailman.cfg``. (LP: #1157861)
@@ -291,10 +291,10 @@
Commands
--------
- * `bin/mailman aliases` loses the `--output`, `--format`, and `--simple`
+ * `mailman aliases` loses the `--output`, `--format`, and `--simple`
arguments, and adds a `--directory` argument. This is necessary to support
the Postfix `relay_domains` support.
- * `bin/mailman start` was passing the wrong relative path to its runner
+ * `mailman start` was passing the wrong relative path to its runner
subprocesses when -C was given. (LP: #982551)
* `bin/runner` command has been simplified and its command line options
reduced. Now, only one `-r/--runner` option may be provided and the
@@ -437,7 +437,7 @@
(LP: #953497)
* List-Post should be NO when posting is not allowed. (LP: #987563)
* Non-unicode values in msgdata broke pending requests. (LP: #1031391)
- * Show devmode in `bin/mailman info` output. (LP: #1035028)
+ * Show devmode in `mailman info` output. (LP: #1035028)
* Fix residual references to the old `IMailingList` archive variables.
(LP: #1031393)
@@ -546,11 +546,11 @@
Commands
--------
- * IPython support in `bin/mailman shell` contributed by Andrea Crotti.
+ * IPython support in `mailman shell` contributed by Andrea Crotti.
(LP: #949926).
* The `mailman.cfg` configuration file will now automatically be detected if
it exists in an `etc` directory which is a sibling of argv0.
- * `bin/mailman shell` is an alias for `withlist`.
+ * `mailman shell` is an alias for `withlist`.
* The `confirm` email command now properly handles `Re:`-like prefixes, even
if they contain non-ASCII characters. (LP: #685261)
* The `join` email command no longer accepts an `address=` argument. Its
@@ -638,10 +638,10 @@
Commands
--------
* `bin/qrunner` is renamed to `bin/runner`.
- * `bin/mailman aliases` gains `-f` and `-s` options.
- * `bin/mailman create` no longer allows a list to be created with bogus owner
+ * `mailman aliases` gains `-f` and `-s` options.
+ * `mailman create` no longer allows a list to be created with bogus owner
addresses. (LP: #778687)
- * `bin/mailman start --force` option is fixed. (LP: #869317)
+ * `mailman start --force` option is fixed. (LP: #869317)
Documentation
-------------
@@ -715,11 +715,11 @@
Commands
--------
- * 'bin/mailman start' does a better job of producing an error when Mailman is
+ * 'mailman start' does a better job of producing an error when Mailman is
already running.
- * 'bin/mailman status' added for providing command line status on the master
+ * 'mailman status' added for providing command line status on the master
queue runner watcher process.
- * 'bin/mailman info' now prints the REST root url and credentials.
+ * 'mailman info' now prints the REST root url and credentials.
* mmsitepass removed; there is no more site password.
REST
@@ -763,8 +763,8 @@
Commands
--------
* The functionality of 'bin/list_members' has been moved to
- 'bin/mailman members'.
- * 'bin/mailman info' -v/--verbose output displays the file system
+ 'mailman members'.
+ * 'mailman info' -v/--verbose output displays the file system
layout paths Mailman is currently configured to use.
Configuration
@@ -825,8 +825,8 @@
Commands
--------
- * 'bin/dumpdb' is now 'bin/mailman qfile'
- * 'bin/unshunt' is now 'bin/mailman unshunt'
+ * 'bin/dumpdb' is now 'mailman qfile'
+ * 'bin/unshunt' is now 'mailman unshunt'
* Mailman now properly handles the '-join', '-leave', and '-confirm' email
commands and sub-addresses. '-subscribe' and '-unsubscribe' are aliases
for '-join' and '-leave' respectively.
@@ -850,16 +850,16 @@
Commands
--------
- * 'bin/inject' is now 'bin/mailman inject', with some changes
- * 'bin/mailmanctl' is now 'bin/mailman start|stop|reopen|restart'
- * 'bin/mailman version' is added (output same as 'bin/mailman --version')
- * 'bin/mailman members' command line arguments have changed. It also
+ * 'inject' is now 'mailman inject', with some changes
+ * 'mailmanctl' is now 'mailman start|stop|reopen|restart'
+ * 'mailman version' is added (output same as 'mailman --version')
+ * 'mailman members' command line arguments have changed. It also
now ignores blank lines and lines that start with #. It also no longer
quits when it sees an address that's already subscribed.
- * 'bin/withlist' is now 'bin/mailman withlist', and its command line
+ * 'bin/withlist' is now 'mailman withlist', and its command line
arguments have changed.
- * 'bin/mailman lists' command line arguments have changed.
- * 'bin/genaliases' is now 'bin/mailman aliases'
+ * 'mailman lists' command line arguments have changed.
+ * 'bin/genaliases' is now 'mailman aliases'
Architecture
------------
@@ -901,7 +901,7 @@
Architecture
------------
- * 'bin/mailman' is a new super-command for managing Mailman from the command
+ * 'mailman' is a new super-command for managing Mailman from the command
line. Some older bin scripts have been converted, with more to come.
* Mailman now has an administrative REST interface which can be used to get
information from and manage Mailman remotely.
=== modified file 'src/mailman/docs/START.rst'
--- src/mailman/docs/START.rst 2015-01-05 01:22:39 +0000
+++ src/mailman/docs/START.rst 2015-03-12 16:35:40 +0000
@@ -188,14 +188,14 @@
* ``/etc/mailman.cfg``
* ``argv[0]/../../etc/mailman.cfg``
-Run the ``bin/mailman info`` command to see which configuration file Mailman
+Run the ``mailman info`` command to see which configuration file Mailman
will use, and where it will put its database file. The first time you run
this, Mailman will also create any necessary run-time directories and log
files.
-Try ``bin/mailman --help`` for more details. You can use the commands
-``bin/mailman start`` to start the runner subprocess daemons, and of course
-``bin/mailman stop`` to stop them.
+Try ``mailman --help`` for more details. You can use the commands
+``mailman start`` to start the runner subprocess daemons, and of course
+``mailman stop`` to stop them.
Postorius, a web UI for administration and subscriber settings, is being
developed as a separate, Django-based project. For now, the most flexible
_______________________________________________
Mailman-coders mailing list
[email protected]
https://mail.python.org/mailman/listinfo/mailman-coders
