summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2019-11-21 20:33:26 +0100
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2019-11-21 22:06:30 +0100
commitf8b68539d0ddda5964d533c2eb9c0d8bff95616b (patch)
treeb19a85e65ef9348bf7efc8981f0ce9d8e1fc2473
parentb0343f8c96e984211c24c3ba404f0a82b60244b4 (diff)
downloadsystemd-f8b68539d0ddda5964d533c2eb9c0d8bff95616b.tar.gz
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.
-rw-r--r--man/daemon.xml2
-rw-r--r--man/journal-upload.conf.xml2
-rw-r--r--man/less-variables.xml2
-rw-r--r--man/systemd-cgtop.xml2
-rw-r--r--man/systemd-fsck@.service.xml2
-rw-r--r--man/systemd-makefs@.service.xml2
-rw-r--r--man/systemd.exec.xml13
-rw-r--r--man/systemd.generator.xml2
-rw-r--r--man/systemd.resource-control.xml11
-rw-r--r--man/systemd.service.xml4
-rw-r--r--man/systemd.unit.xml4
-rw-r--r--man/tmpfiles.d.xml2
-rwxr-xr-xtools/make-directive-index.py2
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 @@
<listitem><para>In the daemon process, write the daemon PID
(as returned by <function>getpid()</function>) to a PID file,
- for example <filename>/run/foobar.pid</filename> (for a
+ for example <filename index='false'>/run/foobar.pid</filename> (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 @@
<term><varname>URL=</varname></term>
<listitem><para>The URL to upload the journal entries to. See the description
- of <varname>--url=</varname> option in
+ of <option>--url=</option> option in
<citerefentry><refentrytitle>systemd-journal-upload</refentrytitle><manvolnum>8</manvolnum></citerefentry>
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.</para></listitem>
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 @@
<para>Users might want to change two options in particular:</para>
- <variablelist class='environment-variables'>
+ <variablelist>
<varlistentry>
<term><option>K</option></term>
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 @@
<para>If <command>systemd-cgtop</command> is not connected to a
tty, no column headers are printed and the default is to only run
- one iteration. The <varname>--iterations=</varname> argument, if
+ one iteration. The <option>--iterations=</option> argument, if
given, is honored. This mode is suitable for scripting.</para>
<para>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 @@
<para><filename>systemd-fsck</filename> does not know any details
about specific filesystems, and simply executes file system
checkers specific to each filesystem type
- (<filename>/sbin/fsck.*</filename>). These checkers will decide if
+ (<filename>/sbin/fsck.<replaceable>type</replaceable></filename>). These checkers will decide if
the filesystem should actually be checked based on the time since
last check, number of mounts, unclean unmount, etc.</para>
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 @@
<para><filename>systemd-makefs</filename> 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 (<filename>/sbin/mkfs.*</filename>).</para>
+ each filesystem type (<filename>/sbin/mkfs.<replaceable>type</replaceable></filename>).</para>
<para><filename>systemd-growfs</filename> 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 @@
<para>Example: if a unit has the following,
<programlisting>CapabilityBoundingSet=CAP_A CAP_B
CapabilityBoundingSet=CAP_B CAP_C</programlisting>
- then <constant>CAP_A</constant>, <constant>CAP_B</constant>, and <constant>CAP_C</constant> are set.
- If the second line is prefixed with <literal>~</literal>, e.g.,
+ then <constant index='false'>CAP_A</constant>, <constant index='false'>CAP_B</constant>, and
+ <constant index='false'>CAP_C</constant> are set. If the second line is prefixed with
+ <literal>~</literal>, e.g.,
<programlisting>CapabilityBoundingSet=CAP_A CAP_B
CapabilityBoundingSet=~CAP_B CAP_C</programlisting>
- then, only <constant>CAP_A</constant> is set.</para></listitem>
+ then, only <constant index='false'>CAP_A</constant> is set.</para></listitem>
</varlistentry>
<varlistentry>
@@ -994,8 +995,10 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting>
<para>Example: if a system service unit has the following,
<programlisting>RuntimeDirectory=foo/bar baz</programlisting>
the service manager creates <filename>/run/foo</filename> (if it does not exist),
- <filename>/run/foo/bar</filename>, and <filename>/run/baz</filename>. The directories
- <filename>/run/foo/bar</filename> and <filename>/run/baz</filename> except <filename>/run/foo</filename> are
+
+ <filename index='false'>/run/foo/bar</filename>, and <filename index='false'>/run/baz</filename>. The
+ directories <filename index='false'>/run/foo/bar</filename> and
+ <filename index='false'>/run/baz</filename> except <filename index='false'>/run/foo</filename> are
owned by the user and group specified in <varname>User=</varname> and <varname>Group=</varname>, and removed
when the service is stopped.</para>
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 @@
<refsynopsisdiv>
<cmdsynopsis>
- <command>/path/to/generator</command>
+ <command index='false'>/path/to/generator</command>
<arg choice="plain"><replaceable>normal-dir</replaceable></arg>
<arg choice="plain"><replaceable>early-dir</replaceable></arg>
<arg choice="plain"><replaceable>late-dir</replaceable></arg>
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 @@
<variablelist>
<varlistentry>
- <term><option>CPU</option></term>
+ <term>CPU</term>
<listitem>
<para><varname>CPUWeight=</varname> and <varname>StartupCPUWeight=</varname> replace
<varname>CPUShares=</varname> and <varname>StartupCPUShares=</varname>, respectively.</para>
@@ -101,7 +101,7 @@
</varlistentry>
<varlistentry>
- <term><option>Memory</option></term>
+ <term>Memory</term>
<listitem>
<para><varname>MemoryMax=</varname> replaces <varname>MemoryLimit=</varname>. <varname>MemoryLow=</varname>
and <varname>MemoryHigh=</varname> are effective only on unified hierarchy.</para>
@@ -109,10 +109,11 @@
</varlistentry>
<varlistentry>
- <term><option>IO</option></term>
+ <term>IO</term>
<listitem>
- <para><varname>IO</varname> prefixed settings are a superset of and replace <varname>BlockIO</varname>
- prefixed ones. On unified hierarchy, IO resource control also applies to buffered writes.</para>
+ <para><literal>IO</literal>-prefixed settings are a superset of and replace
+ <literal>BlockIO</literal>-prefixed ones. On unified hierarchy, IO resource control also applies
+ to buffered writes.</para>
</listitem>
</varlistentry>
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 @@
<varlistentry>
<term><varname>TimeoutStopSec=</varname></term>
<listitem><para>This option serves two purposes. First, it configures the time to wait for each
- <constant>ExecStop=</constant> command. If any of them times out, subsequent <constant>ExecStop=</constant> commands
- are skipped and the service will be terminated by <constant>SIGTERM</constant>. If no <constant>ExecStop=</constant>
+ <varname>ExecStop=</varname> command. If any of them times out, subsequent <varname>ExecStop=</varname> commands
+ are skipped and the service will be terminated by <constant>SIGTERM</constant>. If no <varname>ExecStop=</varname>
commands are specified, the service gets the <constant>SIGTERM</constant> 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 <constant>SIGKILL</constant> (see <varname>KillMode=</varname> 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 @@
<filename>/run/systemd/system/*</filename>
<filename>/run/systemd/systemd.attached/*</filename>
<filename>/run/systemd/generator/*</filename>
-<filename>…</filename>
+<filename index='false'>…</filename>
<filename>/usr/lib/systemd/system/*</filename>
<filename>/run/systemd/generator.late/*</filename></literallayout></para>
</refsect2>
@@ -65,7 +65,7 @@
<filename>/run/systemd/user/*</filename>
<filename>$XDG_RUNTIME_DIR/systemd/generator/*</filename>
<filename>~/.local/share/systemd/user/*</filename>
-<filename>…</filename>
+<filename index='false'>…</filename>
<filename>/usr/lib/systemd/user/*</filename>
<filename>$XDG_RUNTIME_DIR/systemd/generator.late/*</filename></literallayout></para>
</refsect2>
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 @@
<para><literallayout><filename>~/.config/user-tmpfiles.d/*.conf</filename>
<filename>$XDG_RUNTIME_DIR/user-tmpfiles.d/*.conf</filename>
<filename>~/.local/share/user-tmpfiles.d/*.conf</filename>
-<filename>…</filename>
+<filename index='false'>…</filename>
<filename>/usr/share/user-tmpfiles.d/*.conf</filename>
</literallayout></para>
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 = ''