From f8b68539d0ddda5964d533c2eb9c0d8bff95616b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Thu, 21 Nov 2019 20:33:26 +0100 Subject: [PATCH] man: fix a few bogus entries in directives index When wrong element types are used, directives are sometimes placed in the wrong section. Also, strip part of text starting with "'", which is used in a few places and which is displayed improperly in the index. --- man/daemon.xml | 2 +- man/journal-upload.conf.xml | 2 +- man/less-variables.xml | 2 +- man/systemd-cgtop.xml | 2 +- man/systemd-fsck@.service.xml | 2 +- man/systemd-makefs@.service.xml | 2 +- man/systemd.exec.xml | 13 ++++++++----- man/systemd.generator.xml | 2 +- man/systemd.resource-control.xml | 11 ++++++----- man/systemd.service.xml | 4 ++-- man/systemd.unit.xml | 4 ++-- man/tmpfiles.d.xml | 2 +- tools/make-directive-index.py | 2 +- 13 files changed, 27 insertions(+), 23 deletions(-) diff --git a/man/daemon.xml b/man/daemon.xml index 79ea55ba26..52b3883607 100644 --- a/man/daemon.xml +++ b/man/daemon.xml @@ -102,7 +102,7 @@ In the daemon process, write the daemon PID (as returned by getpid()) to a PID file, - for example /run/foobar.pid (for a + for example /run/foobar.pid (for a hypothetical daemon "foobar") to ensure that the daemon cannot be started more than once. This must be implemented in race-free fashion so that the PID file is only updated when it diff --git a/man/journal-upload.conf.xml b/man/journal-upload.conf.xml index 6b946bf649..f2721a75e7 100644 --- a/man/journal-upload.conf.xml +++ b/man/journal-upload.conf.xml @@ -50,7 +50,7 @@ URL= The URL to upload the journal entries to. See the description - of --url= option in + of option in systemd-journal-upload8 for the description of possible values. There is no default value, so either this option or the command-line option must be always present to make an upload. diff --git a/man/less-variables.xml b/man/less-variables.xml index 8a701277b6..03e4b35388 100644 --- a/man/less-variables.xml +++ b/man/less-variables.xml @@ -27,7 +27,7 @@ Users might want to change two options in particular: - + diff --git a/man/systemd-cgtop.xml b/man/systemd-cgtop.xml index a850a57c97..5beeb586d7 100644 --- a/man/systemd-cgtop.xml +++ b/man/systemd-cgtop.xml @@ -42,7 +42,7 @@ If systemd-cgtop is not connected to a tty, no column headers are printed and the default is to only run - one iteration. The --iterations= argument, if + one iteration. The argument, if given, is honored. This mode is suitable for scripting. Resource usage is only accounted for control groups in the diff --git a/man/systemd-fsck@.service.xml b/man/systemd-fsck@.service.xml index 121b0cdf76..16fad1ae04 100644 --- a/man/systemd-fsck@.service.xml +++ b/man/systemd-fsck@.service.xml @@ -51,7 +51,7 @@ systemd-fsck does not know any details about specific filesystems, and simply executes file system checkers specific to each filesystem type - (/sbin/fsck.*). These checkers will decide if + (/sbin/fsck.type). These checkers will decide if the filesystem should actually be checked based on the time since last check, number of mounts, unclean unmount, etc. diff --git a/man/systemd-makefs@.service.xml b/man/systemd-makefs@.service.xml index 89662b8ae5..f58c1c1f34 100644 --- a/man/systemd-makefs@.service.xml +++ b/man/systemd-makefs@.service.xml @@ -51,7 +51,7 @@ systemd-makefs knows very little about specific file systems and swap devices, and after checking that the block device does not already contain a file system or other content, it will execute binaries specific to - each filesystem type (/sbin/mkfs.*). + each filesystem type (/sbin/mkfs.type). systemd-growfs knows very little about specific file systems and swap devices, and will instruct the kernel to grow the mounted diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 3a11cecb95..7b0b4f18e5 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -356,11 +356,12 @@ Example: if a unit has the following, CapabilityBoundingSet=CAP_A CAP_B CapabilityBoundingSet=CAP_B CAP_C - then CAP_A, CAP_B, and CAP_C are set. - If the second line is prefixed with ~, e.g., + then CAP_A, CAP_B, and + CAP_C are set. If the second line is prefixed with + ~, e.g., CapabilityBoundingSet=CAP_A CAP_B CapabilityBoundingSet=~CAP_B CAP_C - then, only CAP_A is set. + then, only CAP_A is set. @@ -994,8 +995,10 @@ CapabilityBoundingSet=~CAP_B CAP_C Example: if a system service unit has the following, RuntimeDirectory=foo/bar baz the service manager creates /run/foo (if it does not exist), - /run/foo/bar, and /run/baz. The directories - /run/foo/bar and /run/baz except /run/foo are + + /run/foo/bar, and /run/baz. The + directories /run/foo/bar and + /run/baz except /run/foo are owned by the user and group specified in User= and Group=, and removed when the service is stopped. diff --git a/man/systemd.generator.xml b/man/systemd.generator.xml index c77afda0f2..dd0b591996 100644 --- a/man/systemd.generator.xml +++ b/man/systemd.generator.xml @@ -24,7 +24,7 @@ - /path/to/generator + /path/to/generator normal-dir early-dir late-dir diff --git a/man/systemd.resource-control.xml b/man/systemd.resource-control.xml index 7daaba5074..a9600917ea 100644 --- a/man/systemd.resource-control.xml +++ b/man/systemd.resource-control.xml @@ -91,7 +91,7 @@ - + CPU CPUWeight= and StartupCPUWeight= replace CPUShares= and StartupCPUShares=, respectively. @@ -101,7 +101,7 @@ - + Memory MemoryMax= replaces MemoryLimit=. MemoryLow= and MemoryHigh= are effective only on unified hierarchy. @@ -109,10 +109,11 @@ - + IO - IO prefixed settings are a superset of and replace BlockIO - prefixed ones. On unified hierarchy, IO resource control also applies to buffered writes. + IO-prefixed settings are a superset of and replace + BlockIO-prefixed ones. On unified hierarchy, IO resource control also applies + to buffered writes. diff --git a/man/systemd.service.xml b/man/systemd.service.xml index f76005a296..db28e3e272 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -574,8 +574,8 @@ TimeoutStopSec= This option serves two purposes. First, it configures the time to wait for each - ExecStop= command. If any of them times out, subsequent ExecStop= commands - are skipped and the service will be terminated by SIGTERM. If no ExecStop= + ExecStop= command. If any of them times out, subsequent ExecStop= commands + are skipped and the service will be terminated by SIGTERM. If no ExecStop= commands are specified, the service gets the SIGTERM immediately. Second, it configures the time to wait for the service itself to stop. If it doesn't terminate in the specified time, it will be forcibly terminated by SIGKILL (see KillMode= in diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index b7bae08c69..763e3229a7 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -48,7 +48,7 @@ /run/systemd/system/* /run/systemd/systemd.attached/* /run/systemd/generator/* -… +… /usr/lib/systemd/system/* /run/systemd/generator.late/* @@ -65,7 +65,7 @@ /run/systemd/user/* $XDG_RUNTIME_DIR/systemd/generator/* ~/.local/share/systemd/user/* -… +… /usr/lib/systemd/user/* $XDG_RUNTIME_DIR/systemd/generator.late/* diff --git a/man/tmpfiles.d.xml b/man/tmpfiles.d.xml index 8a3dde3644..a497b9b489 100644 --- a/man/tmpfiles.d.xml +++ b/man/tmpfiles.d.xml @@ -33,7 +33,7 @@ ~/.config/user-tmpfiles.d/*.conf $XDG_RUNTIME_DIR/user-tmpfiles.d/*.conf ~/.local/share/user-tmpfiles.d/*.conf -… +… /usr/share/user-tmpfiles.d/*.conf diff --git a/tools/make-directive-index.py b/tools/make-directive-index.py index 2bc178de50..5b965f4163 100755 --- a/tools/make-directive-index.py +++ b/tools/make-directive-index.py @@ -190,7 +190,7 @@ def _extract_directives(directive_groups, formatting, page): stor[text].append((pagename, section)) if text not in formatting: # use element as formatted display - if name.text[-1] in '= ': + if name.text[-1] in "= '": name.clear() else: name.tail = ''