summaryrefslogtreecommitdiff
path: root/src/mailman/bin
diff options
context:
space:
mode:
authorBarry Warsaw2015-03-13 20:56:51 -0400
committerBarry Warsaw2015-03-13 20:56:51 -0400
commita77f6650bc69ce968d3ac60d1b545d9bbdb9c62f (patch)
treeee30bf86419ee964d081897ddc2d4e7ed0b6e976 /src/mailman/bin
parentd7e96af25e7ae428cf07d9170a4cb01c9022eae2 (diff)
parent8d9b19d5f5a5f78d28cb4e04d92a91e746ed7102 (diff)
downloadmailman-a77f6650bc69ce968d3ac60d1b545d9bbdb9c62f.tar.gz
mailman-a77f6650bc69ce968d3ac60d1b545d9bbdb9c62f.tar.zst
mailman-a77f6650bc69ce968d3ac60d1b545d9bbdb9c62f.zip
Documentation fixes, given by Abhilash Raj.
Diffstat (limited to 'src/mailman/bin')
-rw-r--r--src/mailman/bin/docs/master.rst8
-rw-r--r--src/mailman/bin/mailman.py2
-rw-r--r--src/mailman/bin/master.py2
-rw-r--r--src/mailman/bin/runner.py21
4 files changed, 16 insertions, 17 deletions
diff --git a/src/mailman/bin/docs/master.rst b/src/mailman/bin/docs/master.rst
index 3d10b69ac..5a3a94da6 100644
--- a/src/mailman/bin/docs/master.rst
+++ b/src/mailman/bin/docs/master.rst
@@ -4,10 +4,10 @@ Mailman runner control
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``
-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.
+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.
>>> from mailman.testing.helpers import TestableMaster
diff --git a/src/mailman/bin/mailman.py b/src/mailman/bin/mailman.py
index 8814cdfc4..3865fef19 100644
--- a/src/mailman/bin/mailman.py
+++ b/src/mailman/bin/mailman.py
@@ -36,7 +36,7 @@ from zope.interface.verify import verifyObject
def main():
- """bin/mailman"""
+ """The `mailman` command dispatcher."""
# Create the basic parser and add all globally common options.
parser = argparse.ArgumentParser(
description=_("""\
diff --git a/src/mailman/bin/master.py b/src/mailman/bin/master.py
index 492a6b138..5ffe59647 100644
--- a/src/mailman/bin/master.py
+++ b/src/mailman/bin/master.py
@@ -320,7 +320,7 @@ class Loop:
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)
diff --git a/src/mailman/bin/runner.py b/src/mailman/bin/runner.py
index e8c68dad9..87d11dbe9 100644
--- a/src/mailman/bin/runner.py
+++ b/src/mailman/bin/runner.py
@@ -108,19 +108,18 @@ def main():
description=_("""\
Start a runner
- The runner named on the command line is started, and it can
- either run through its main loop once (for those runners that
- support this) or continuously. The latter is how the master
- runner starts all its subprocesses.
+ The runner named on the command line is started, and it can either run
+ through its main loop once (for those runners that support this) or
+ continuously. The latter is how the master runner starts all its
+ subprocesses.
- -r is required unless -l or -h is given, and its argument must
- be one of the names displayed by the -l switch.
+ -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
- 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
- some error handling behavior.
+ 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 some error handling behavior.
"""))
parser.add_argument(
'--version',