]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
man: fix a few bogus entries in directives index
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Thu, 21 Nov 2019 19:33:26 +0000 (20:33 +0100)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Thu, 21 Nov 2019 21:06:30 +0000 (22:06 +0100)
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.

13 files changed:
man/daemon.xml
man/journal-upload.conf.xml
man/less-variables.xml
man/systemd-cgtop.xml
man/systemd-fsck@.service.xml
man/systemd-makefs@.service.xml
man/systemd.exec.xml
man/systemd.generator.xml
man/systemd.resource-control.xml
man/systemd.service.xml
man/systemd.unit.xml
man/tmpfiles.d.xml
tools/make-directive-index.py

index 79ea55ba26536eda78ad18ce97d7df65eb40c65b..52b3883607cf9c8ea49339512b24ba8d0a515bd6 100644 (file)
 
         <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
index 6b946bf649e92ae5025d1971339f574e2cbf62c7..f2721a75e7d271669a3fcf90d870f516646f757f 100644 (file)
@@ -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>
index 8a701277b6e1546d637f5bbf157f071d8fb300fd..03e4b353883c9d22e6b65d57b66b800fe0bc8f6b 100644 (file)
@@ -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>
 
index a850a57c97f0dced404c26020fd99387ccccfff7..5beeb586d7c1e269751f585b5fd12d5e15027416 100644 (file)
@@ -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
index 121b0cdf76f2dca62fd72c4df4df3d24e49b9e5c..16fad1ae04d118017a7b7ee675bc4390aa0ced34 100644 (file)
@@ -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>
 
index 89662b8ae51aa39d0c0d9dfcfa1e85c5c46d1d2d..f58c1c1f34b9250b7a1a26b9861bc3bf83d0f1b0 100644 (file)
@@ -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
index 3a11cecb959f7359e506e73294eefcc4a697a135..7b0b4f18e574306545356308c214b9556a77db8b 100644 (file)
         <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>
 
index c77afda0f2193e16113b7baf79ca987da558cef6..dd0b5919960768952bb6f7a273a8a9dd59d8a610 100644 (file)
@@ -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>
index 7daaba5074a7774f411624cda7ff1256cef0f7b8..a9600917ea465b17ecb623c6a2bacf79d1eace73 100644 (file)
@@ -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>
         </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>
         </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>
 
index f76005a296ce719728b6e181de3446fdfcdf8184..db28e3e272958cf14b52981ce15606c5eea9fa40 100644 (file)
       <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
index b7bae08c696be93a9a1af0be587eb68799650f08..763e3229a7a6ce9aea595f52ff50d212c2ff3fad 100644 (file)
@@ -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>
index 8a3dde3644c54ac7e59b12d47c323880af8704b1..a497b9b4894770b8b5a3dd3203e475a87ee6a35f 100644 (file)
@@ -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>
 
index 2bc178de50765e2abfe843439cbb0cda88c8e8b9..5b965f416326707b52e84c297e8bc33b001c2d29 100755 (executable)
@@ -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 = ''