]> git.ipfire.org Git - thirdparty/systemd.git/commitdiff
Merge pull request #30616 from dtardon/docbook-valid-2
authorYu Watanabe <watanabe.yu+github@gmail.com>
Mon, 25 Dec 2023 11:00:23 +0000 (20:00 +0900)
committerGitHub <noreply@github.com>
Mon, 25 Dec 2023 11:00:23 +0000 (20:00 +0900)
DocBook validation fixes (part 2)

14 files changed:
man/sd_bus_add_object.xml
man/standard-conf.xml
man/systemd-analyze.xml
man/systemd-backlight@.service.xml
man/systemd-fsck@.service.xml
man/systemd-integritysetup@.service.xml
man/systemd-makefs@.service.xml
man/systemd-veritysetup@.service.xml
man/systemd.net-naming-scheme.xml
man/systemd.resource-control.xml
man/udevadm.xml
man/ukify.xml
man/user@.service.xml
tools/make-man-index.py

index b73ddc815a82c08eea8a2772f6e4f08db0e5d06f..7801f8825f2dea3993d3765bec7fc824424be898 100644 (file)
         <paramdef>sd_bus_message_handler_t <parameter>callback</parameter></paramdef>
         <paramdef>void *<parameter>userdata</parameter></paramdef>
       </funcprototype>
+    </funcsynopsis>
 
-      <para>
-        <constant>SD_BUS_VTABLE_CAPABILITY(<replaceable>capability</replaceable>)</constant>
-      </para>
+    <para>
+      <constant>SD_BUS_VTABLE_CAPABILITY(<replaceable>capability</replaceable>)</constant>
+    </para>
 
-      <para>
-        <constant>SD_BUS_VTABLE_START(<replaceable>flags</replaceable>)</constant>
-      </para>
-      <para>
-        <constant>SD_BUS_VTABLE_END</constant>
-      </para>
-      <para>
-        <constant>SD_BUS_METHOD_WITH_ARGS_OFFSET(<replaceable>member</replaceable>,
-        <replaceable>args</replaceable>,
-        <replaceable>result</replaceable>,
-        <replaceable>handler</replaceable>,
-        <replaceable>offset</replaceable>,
-        <replaceable>flags</replaceable>)
-        </constant>
-      </para>
-      <para>
-        <constant>SD_BUS_METHOD_WITH_ARGS(<replaceable>member</replaceable>,
-        <replaceable>args</replaceable>,
-        <replaceable>result</replaceable>,
-        <replaceable>handler</replaceable>,
-        <replaceable>flags</replaceable>)
-        </constant>
-      </para>
-      <para>
-        <constant>SD_BUS_METHOD_WITH_NAMES_OFFSET(<replaceable>member</replaceable>,
-        <replaceable>signature</replaceable>,
-        <replaceable>in_names</replaceable>,
-        <replaceable>result</replaceable>,
-        <replaceable>out_names</replaceable>,
-        <replaceable>handler</replaceable>,
-        <replaceable>offset</replaceable>,
-        <replaceable>flags</replaceable>)
-        </constant>
-      </para>
-      <para>
-        <constant>SD_BUS_METHOD_WITH_NAMES(<replaceable>member</replaceable>,
-        <replaceable>signature</replaceable>,
-        <replaceable>in_names</replaceable>,
-        <replaceable>result</replaceable>,
-        <replaceable>out_names</replaceable>,
-        <replaceable>handler</replaceable>,
-        <replaceable>flags</replaceable>)
-        </constant>
-      </para>
-      <para>
-        <constant>SD_BUS_METHOD_WITH_OFFSET(<replaceable>member</replaceable>,
-        <replaceable>signature</replaceable>,
-        <replaceable>result</replaceable>,
-        <replaceable>handler</replaceable>,
-        <replaceable>offset</replaceable>,
-        <replaceable>flags</replaceable>)
-        </constant>
-      </para>
-      <para>
-        <constant>SD_BUS_METHOD(<replaceable>member</replaceable>,
-        <replaceable>signature</replaceable>,
-        <replaceable>result</replaceable>,
-        <replaceable>handler</replaceable>,
-        <replaceable>flags</replaceable>)
-        </constant>
-      </para>
-      <para>
-        <constant>SD_BUS_SIGNAL_WITH_ARGS(<replaceable>member</replaceable>,
-        <replaceable>args</replaceable>,
-        <replaceable>flags</replaceable>)
-        </constant>
-      </para>
-      <para>
-        <constant>SD_BUS_SIGNAL_WITH_NAMES(<replaceable>member</replaceable>,
-        <replaceable>signature</replaceable>,
-        <replaceable>names</replaceable>,
-        <replaceable>flags</replaceable>)
-        </constant>
-      </para>
-      <para>
-        <constant>SD_BUS_SIGNAL(<replaceable>member</replaceable>,
-        <replaceable>signature</replaceable>,
-        <replaceable>flags</replaceable>)
-        </constant>
-      </para>
-      <para>
-        <constant>SD_BUS_WRITABLE_PROPERTY(<replaceable>member</replaceable>,
-        <replaceable>signature</replaceable>,
-        <replaceable>get</replaceable>,
-        <replaceable>set</replaceable>,
-        <replaceable>offset</replaceable>,
-        <replaceable>flags</replaceable>)
-        </constant>
-      </para>
-      <para>
-        <constant>SD_BUS_PROPERTY(<replaceable>member</replaceable>,
-        <replaceable>signature</replaceable>,
-        <replaceable>get</replaceable>,
-        <replaceable>offset</replaceable>,
-        <replaceable>flags</replaceable>)
-        </constant>
-      </para>
-      <para>
-        <constant>SD_BUS_PARAM(<replaceable>name</replaceable>)</constant>
-      </para>
-      <para>
-        <constant>SD_BUS_ARGS(<replaceable>...</replaceable>)</constant>
-      </para>
-      <para>
-        <constant>SD_BUS_RESULT(<replaceable>...</replaceable>)</constant>
-      </para>
-      <para>
-        <constant>SD_BUS_NO_ARGS</constant>
-      </para>
-      <para>
-        <constant>SD_BUS_NO_RESULT</constant>
-      </para>
-    </funcsynopsis>
+    <para>
+      <constant>SD_BUS_VTABLE_START(<replaceable>flags</replaceable>)</constant>
+    </para>
+    <para>
+      <constant>SD_BUS_VTABLE_END</constant>
+    </para>
+    <para>
+      <constant>SD_BUS_METHOD_WITH_ARGS_OFFSET(<replaceable>member</replaceable>,
+      <replaceable>args</replaceable>,
+      <replaceable>result</replaceable>,
+      <replaceable>handler</replaceable>,
+      <replaceable>offset</replaceable>,
+      <replaceable>flags</replaceable>)
+      </constant>
+    </para>
+    <para>
+      <constant>SD_BUS_METHOD_WITH_ARGS(<replaceable>member</replaceable>,
+      <replaceable>args</replaceable>,
+      <replaceable>result</replaceable>,
+      <replaceable>handler</replaceable>,
+      <replaceable>flags</replaceable>)
+      </constant>
+    </para>
+    <para>
+      <constant>SD_BUS_METHOD_WITH_NAMES_OFFSET(<replaceable>member</replaceable>,
+      <replaceable>signature</replaceable>,
+      <replaceable>in_names</replaceable>,
+      <replaceable>result</replaceable>,
+      <replaceable>out_names</replaceable>,
+      <replaceable>handler</replaceable>,
+      <replaceable>offset</replaceable>,
+      <replaceable>flags</replaceable>)
+      </constant>
+    </para>
+    <para>
+      <constant>SD_BUS_METHOD_WITH_NAMES(<replaceable>member</replaceable>,
+      <replaceable>signature</replaceable>,
+      <replaceable>in_names</replaceable>,
+      <replaceable>result</replaceable>,
+      <replaceable>out_names</replaceable>,
+      <replaceable>handler</replaceable>,
+      <replaceable>flags</replaceable>)
+      </constant>
+    </para>
+    <para>
+      <constant>SD_BUS_METHOD_WITH_OFFSET(<replaceable>member</replaceable>,
+      <replaceable>signature</replaceable>,
+      <replaceable>result</replaceable>,
+      <replaceable>handler</replaceable>,
+      <replaceable>offset</replaceable>,
+      <replaceable>flags</replaceable>)
+      </constant>
+    </para>
+    <para>
+      <constant>SD_BUS_METHOD(<replaceable>member</replaceable>,
+      <replaceable>signature</replaceable>,
+      <replaceable>result</replaceable>,
+      <replaceable>handler</replaceable>,
+      <replaceable>flags</replaceable>)
+      </constant>
+    </para>
+    <para>
+      <constant>SD_BUS_SIGNAL_WITH_ARGS(<replaceable>member</replaceable>,
+      <replaceable>args</replaceable>,
+      <replaceable>flags</replaceable>)
+      </constant>
+    </para>
+    <para>
+      <constant>SD_BUS_SIGNAL_WITH_NAMES(<replaceable>member</replaceable>,
+      <replaceable>signature</replaceable>,
+      <replaceable>names</replaceable>,
+      <replaceable>flags</replaceable>)
+      </constant>
+    </para>
+    <para>
+      <constant>SD_BUS_SIGNAL(<replaceable>member</replaceable>,
+      <replaceable>signature</replaceable>,
+      <replaceable>flags</replaceable>)
+      </constant>
+    </para>
+    <para>
+      <constant>SD_BUS_WRITABLE_PROPERTY(<replaceable>member</replaceable>,
+      <replaceable>signature</replaceable>,
+      <replaceable>get</replaceable>,
+      <replaceable>set</replaceable>,
+      <replaceable>offset</replaceable>,
+      <replaceable>flags</replaceable>)
+      </constant>
+    </para>
+    <para>
+      <constant>SD_BUS_PROPERTY(<replaceable>member</replaceable>,
+      <replaceable>signature</replaceable>,
+      <replaceable>get</replaceable>,
+      <replaceable>offset</replaceable>,
+      <replaceable>flags</replaceable>)
+      </constant>
+    </para>
+    <para>
+      <constant>SD_BUS_PARAM(<replaceable>name</replaceable>)</constant>
+    </para>
+    <para>
+      <constant>SD_BUS_ARGS(<replaceable>...</replaceable>)</constant>
+    </para>
+    <para>
+      <constant>SD_BUS_RESULT(<replaceable>...</replaceable>)</constant>
+    </para>
+    <para>
+      <constant>SD_BUS_NO_ARGS</constant>
+    </para>
+    <para>
+      <constant>SD_BUS_NO_RESULT</constant>
+    </para>
   </refsynopsisdiv>
 
   <refsect1>
index 0174c090e91224796ce8cf63d238de41692de73c..2f56c95fbb40cf069eea1351655d65b0ee0d3f5a 100644 (file)
@@ -1,5 +1,5 @@
 <?xml version="1.0"?>
-<!DOCTYPE refsection PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
           "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
 
 <!--
@@ -7,10 +7,13 @@
   Copyright © 2014 Josh Triplett
 -->
 
-<refsection>
-  <title/>
+<refentry>
+  <refnamediv>
+    <refname/>
+    <refpurpose/>
+  </refnamediv>
 
-  <refsection id='confd'>
+  <refsect1 id='confd'>
     <title>Configuration Directories and Precedence</title>
 
     <para>Configuration files are read from directories in <filename>/etc/</filename>,
@@ -38,9 +41,9 @@
     way is to place a symlink to <filename>/dev/null</filename> in the configuration directory in
     <filename>/etc/</filename>, with the same filename as the vendor configuration file. If the vendor
     configuration file is included in the initrd image, the image has to be regenerated.</para>
-  </refsection>
+  </refsect1>
 
-  <refsection id='main-conf'>
+  <refsect1 id='main-conf'>
     <title>Configuration Directories and Precedence</title>
 
     <para>The default configuration is set during compilation, so configuration is only needed when it is
@@ -72,5 +75,5 @@
     <para>To disable a configuration file supplied by the vendor, the recommended way is to place a symlink
     to <filename>/dev/null</filename> in the configuration directory in <filename>/etc/</filename>, with the
     same filename as the vendor configuration file.</para>
-  </refsection>
-</refsection>
+  </refsect1>
+</refentry>
index 6f6f021f3086203fc1b713e4aaf3adba7d4deb7e..68062049c4ad01d453370149744be691e0c855c0 100644 (file)
     <cmdsynopsis>
       <command>systemd-analyze</command>
       <arg choice="opt" rep="repeat">OPTIONS</arg>
-      <arg choice="plain">srk</arg> &gt;<arg choice="plain"><replaceable>FILE</replaceable></arg>
+      <arg choice="plain">srk</arg>
     </cmdsynopsis>
     <cmdsynopsis>
       <command>systemd-analyze</command>
index 431b27bbb095724ed7f76c86af745dc53301480d..95fa518bffd45949cf8f2edc03e8e9b826365db4 100644 (file)
@@ -3,7 +3,7 @@
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
-<refentry id="systemd-backlight@.service" conditional='ENABLE_BACKLIGHT'
+<refentry id="systemd-backlight_.service" conditional='ENABLE_BACKLIGHT'
           xmlns:xi="http://www.w3.org/2001/XInclude">
 
   <refentryinfo>
index 5f351ded356e5607e7e8e7f1e2ed10ea63b742c8..a138bd0107cd43e7af0419ac9d4a8159bd521736 100644 (file)
@@ -3,7 +3,7 @@
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
-<refentry id="systemd-fsck@.service" xmlns:xi="http://www.w3.org/2001/XInclude">
+<refentry id="systemd-fsck_.service" xmlns:xi="http://www.w3.org/2001/XInclude">
 
   <refentryinfo>
     <title>systemd-fsck@.service</title>
index a090b1c7639a922050e76da983a74ce940f734a8..831c3690e1ba88b2a04f898c71738f28bf3c8e4c 100644 (file)
@@ -3,7 +3,7 @@
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
-<refentry id="systemd-integritysetup@.service" conditional='HAVE_LIBCRYPTSETUP'
+<refentry id="systemd-integritysetup_.service" conditional='HAVE_LIBCRYPTSETUP'
           xmlns:xi="http://www.w3.org/2001/XInclude">
 
   <refentryinfo>
index 0b54ba3584a1aceb08fa62967b1f33906f968005..5447de0405601d81829ca11cacaa6b754630982a 100644 (file)
@@ -3,7 +3,7 @@
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
-<refentry id="systemd-makefs@.service">
+<refentry id="systemd-makefs_.service">
 
   <refentryinfo>
     <title>systemd-makefs@.service</title>
index 4a4d8d9814a68ed594e288f6ec8a0b7c45a1dedb..a549b41b704dd04e9d2c8cca2eeca5f66c0a6645 100644 (file)
@@ -3,7 +3,7 @@
 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
-<refentry id="systemd-veritysetup@.service" conditional='HAVE_LIBCRYPTSETUP'
+<refentry id="systemd-veritysetup_.service" conditional='HAVE_LIBCRYPTSETUP'
           xmlns:xi="http://www.w3.org/2001/XInclude">
 
   <refentryinfo>
index 07ab26e6f6b0087d2247d6f7f19b3f0112871f4e..ed1c5ec46bc384f73cc7bd55ec31da23a30115b9 100644 (file)
@@ -97,8 +97,8 @@
 
     <variablelist>
         <varlistentry>
-          <term><varname>ID_NET_NAME_ONBOARD=<replaceable>prefix</replaceable><constant>o</constant><replaceable>number</replaceable></varname></term>
-          <term><varname>ID_NET_NAME_ONBOARD=<replaceable>prefix</replaceable><constant>d</constant><replaceable>number</replaceable></varname></term>
+          <term><varname>ID_NET_NAME_ONBOARD=</varname><replaceable>prefix</replaceable><constant>o</constant><replaceable>number</replaceable></term>
+          <term><varname>ID_NET_NAME_ONBOARD=</varname><replaceable>prefix</replaceable><constant>d</constant><replaceable>number</replaceable></term>
 
           <listitem><para>This name is set based on the numeric ordering information given by the firmware
           for on-board devices. Different schemes are used depending on the firmware type, as described in
         </varlistentry>
 
         <varlistentry>
-          <term><varname>ID_NET_LABEL_ONBOARD=<replaceable>prefix</replaceable> <replaceable>label</replaceable></varname></term>
+          <term><varname>ID_NET_LABEL_ONBOARD=</varname><replaceable>prefix</replaceable> <replaceable>label</replaceable></term>
 
           <listitem><para>This property is set based on textual label given by the firmware for on-board
           devices. The name consists of the prefix concatenated with the label. This is only available for
         </varlistentry>
 
         <varlistentry>
-          <term><varname>ID_NET_NAME_MAC=<replaceable>prefix</replaceable><constant>x</constant><replaceable>AABBCCDDEEFF</replaceable></varname></term>
+          <term><varname>ID_NET_NAME_MAC=</varname><replaceable>prefix</replaceable><constant>x</constant><replaceable>AABBCCDDEEFF</replaceable></term>
 
           <listitem><para>This name consists of the prefix, letter <constant>x</constant>, and 12 hexadecimal
           digits of the MAC address. It is available if the device has a fixed MAC address. Because this name
         </varlistentry>
 
         <varlistentry>
-          <term><varname>ID_NET_NAME_SLOT=<replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]</varname></term>
-          <term><varname>ID_NET_NAME_SLOT=<replaceable>prefix</replaceable><constant>v</constant><replaceable>slot</replaceable></varname></term>
-          <term><varname>ID_NET_NAME_SLOT=<replaceable>prefix</replaceable><constant>x</constant><replaceable>slot</replaceable></varname></term>
-          <term><varname>ID_NET_NAME_SLOT=<replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>b</constant><replaceable>number</replaceable></varname></term>
-          <term><varname>ID_NET_NAME_SLOT=<replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>u</constant><replaceable>port</replaceable>…[<constant>c</constant><replaceable>config</replaceable>][<constant>i</constant><replaceable>interface</replaceable>]</varname></term>
-          <term><varname>ID_NET_NAME_SLOT=<replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>v</constant><replaceable>slot</replaceable></varname></term>
-          <term><varname>ID_NET_NAME_SLOT=<replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>r</constant><replaceable>slot</replaceable></varname></term>
+          <term><varname>ID_NET_NAME_SLOT=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]</term>
+          <term><varname>ID_NET_NAME_SLOT=</varname><replaceable>prefix</replaceable><constant>v</constant><replaceable>slot</replaceable></term>
+          <term><varname>ID_NET_NAME_SLOT=</varname><replaceable>prefix</replaceable><constant>x</constant><replaceable>slot</replaceable></term>
+          <term><varname>ID_NET_NAME_SLOT=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>b</constant><replaceable>number</replaceable></term>
+          <term><varname>ID_NET_NAME_SLOT=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>u</constant><replaceable>port</replaceable>…[<constant>c</constant><replaceable>config</replaceable>][<constant>i</constant><replaceable>interface</replaceable>]</term>
+          <term><varname>ID_NET_NAME_SLOT=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>v</constant><replaceable>slot</replaceable></term>
+          <term><varname>ID_NET_NAME_SLOT=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>r</constant><replaceable>slot</replaceable></term>
 
           <listitem><para>This property describes the slot position. Different schemes are used depending on
           the bus type, as described in the table below. In case of USB, BCMA, and SR-VIO devices, the full
         </varlistentry>
 
         <varlistentry>
-          <term><varname>ID_NET_NAME_PATH=<replaceable>prefix</replaceable><constant>c</constant><replaceable>bus_id</replaceable></varname></term>
-          <term><varname>ID_NET_NAME_PATH=<replaceable>prefix</replaceable><constant>a</constant><replaceable>vendor</replaceable><replaceable>model</replaceable><constant>i</constant><replaceable>instance</replaceable></varname></term>
-          <term><varname>ID_NET_NAME_PATH=<replaceable>prefix</replaceable><constant>i</constant><replaceable>address</replaceable><constant>n</constant><replaceable>port_name</replaceable></varname></term>
-          <term><varname>ID_NET_NAME_PATH=<replaceable>prefix</replaceable><constant>u</constant><replaceable>port</replaceable>…</varname></term>
-          <term><varname>ID_NET_NAME_PATH=<replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>p</constant><replaceable>bus</replaceable><constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>phys_port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]</varname></term>
-          <term><varname>ID_NET_NAME_PATH=<replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>p</constant><replaceable>bus</replaceable><constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>phys_port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>b</constant><replaceable>number</replaceable></varname></term>
-          <term><varname>ID_NET_NAME_PATH=<replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>p</constant><replaceable>bus</replaceable><constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>phys_port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>u</constant><replaceable>port</replaceable>…[<constant>c</constant><replaceable>config</replaceable>][<constant>i</constant><replaceable>interface</replaceable>]</varname></term>
+          <term><varname>ID_NET_NAME_PATH=</varname><replaceable>prefix</replaceable><constant>c</constant><replaceable>bus_id</replaceable></term>
+          <term><varname>ID_NET_NAME_PATH=</varname><replaceable>prefix</replaceable><constant>a</constant><replaceable>vendor</replaceable><replaceable>model</replaceable><constant>i</constant><replaceable>instance</replaceable></term>
+          <term><varname>ID_NET_NAME_PATH=</varname><replaceable>prefix</replaceable><constant>i</constant><replaceable>address</replaceable><constant>n</constant><replaceable>port_name</replaceable></term>
+          <term><varname>ID_NET_NAME_PATH=</varname><replaceable>prefix</replaceable><constant>u</constant><replaceable>port</replaceable>…</term>
+          <term><varname>ID_NET_NAME_PATH=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>p</constant><replaceable>bus</replaceable><constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>phys_port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]</term>
+          <term><varname>ID_NET_NAME_PATH=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>p</constant><replaceable>bus</replaceable><constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>phys_port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>b</constant><replaceable>number</replaceable></term>
+          <term><varname>ID_NET_NAME_PATH=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>p</constant><replaceable>bus</replaceable><constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>phys_port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>u</constant><replaceable>port</replaceable>…[<constant>c</constant><replaceable>config</replaceable>][<constant>i</constant><replaceable>interface</replaceable>]</term>
 
           <listitem><para>This property describes the device installation location. Different schemes are
           used depending on the bus type, as described in the table below. For BCMA and USB devices, PCI path
 
     <variablelist>
       <varlistentry>
-        <term><varname>ID_NET_NAME_ALLOW=<replaceable>BOOL</replaceable></varname></term>
+        <term><varname>ID_NET_NAME_ALLOW=</varname><replaceable>BOOL</replaceable></term>
 
         <listitem><para>This udev property sets a fallback policy for reading a sysfs attribute.
         If set to <constant>0</constant> udev will not read any sysfs attribute by default, unless it is
index fee4971a97a7d7104357bc9b20206ce12c5f9865..a86907b2bbf3a66b4511d15be0123efc4d1c5f17 100644 (file)
@@ -151,10 +151,13 @@ CPUWeight=20   DisableControllers=cpu              /          \
       applies to all user slices.</para>
     </refsect2>
 
-    <para>See the <ulink
-    url="https://www.freedesktop.org/wiki/Software/systemd/ControlGroupInterface">New
-    Control Group Interfaces</ulink> for an introduction on how to make
-    use of resource control APIs from programs.</para>
+    <refsect2>
+      <title/>
+      <para>See the <ulink
+      url="https://www.freedesktop.org/wiki/Software/systemd/ControlGroupInterface">New
+      Control Group Interfaces</ulink> for an introduction on how to make
+      use of resource control APIs from programs.</para>
+    </refsect2>
   </refsect1>
 
   <refsect1>
@@ -1669,7 +1672,7 @@ DeviceAllow=/dev/loop-control
       <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
       <member><citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member>
       <member>The documentation for control groups and specific controllers in the Linux kernel:
-      <member><ulink url="https://docs.kernel.org/admin-guide/cgroup-v2.html">Control Groups v2</ulink></member></member>
+      <ulink url="https://docs.kernel.org/admin-guide/cgroup-v2.html">Control Groups v2</ulink></member>
     </simplelist></para>
   </refsect1>
 </refentry>
index 34f7f5c38748e44ae53b4dfdcce325d418ba2dc5..b254a7f249c0915be73ee81966a65eef73cb676c 100644 (file)
@@ -83,8 +83,8 @@
     </variablelist>
 
     <refsect2><title>udevadm info
-      <arg choice="opt"><replaceable>options</replaceable></arg>
-      <arg choice="opt" rep="repeat"><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></arg>
+      <optional><replaceable>options</replaceable></optional>
+      <optional><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></optional>
     </title>
 
       <para>Query the udev database for device information.</para>
     </refsect2>
 
     <refsect2><title>udevadm trigger
-      <arg choice="opt"><replaceable>options</replaceable></arg>
-      <arg choice="opt"><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></arg>
+      <optional><replaceable>options</replaceable></optional>
+      <optional><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></optional>
       </title>
       <para>Request device events from the kernel. Primarily used to replay events at system coldplug time.</para>
 
     </refsect2>
 
     <refsect2><title>udevadm settle
-      <arg choice="opt"><replaceable>options</replaceable></arg>
+      <optional><replaceable>options</replaceable></optional>
     </title>
       <para>Watches the udev event queue, and exits if all current events are handled.</para>
       <variablelist>
     </refsect2>
 
     <refsect2><title>udevadm monitor
-      <arg choice="opt"><replaceable>options</replaceable></arg>
+      <optional><replaceable>options</replaceable></optional>
     </title>
       <para>Listens to the kernel uevents and events sent out by a udev rule
       and prints the devpath of the event to the console. It can be used to analyze the
     </refsect2>
 
     <refsect2><title>udevadm test
-      <arg choice="opt"><replaceable>options</replaceable></arg>
-      <arg choice="opt"><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></arg>
+      <optional><replaceable>options</replaceable></optional>
+      <optional><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></optional>
     </title>
       <para>Simulate a udev event run for the given device, and print debug output.</para>
       <variablelist>
     </refsect2>
 
     <refsect2><title>udevadm test-builtin
-      <arg choice="opt"><replaceable>options</replaceable></arg>
-      <arg><replaceable>command</replaceable></arg>
-      <arg choice="opt"><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></arg>
+      <optional><replaceable>options</replaceable></optional>
+      <replaceable>command</replaceable>
+      <optional><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></optional>
     </title>
       <para>Run a built-in command <replaceable>COMMAND</replaceable>
       for device <replaceable>DEVPATH</replaceable>, and print debug
 
     <refsect2>
       <title>udevadm verify
-      <arg choice="opt"><replaceable>options</replaceable></arg>
-      <arg choice="opt" rep="repeat"><replaceable>file</replaceable></arg>
+      <optional><replaceable>options</replaceable></optional>
+      <optional><replaceable>file</replaceable></optional>
       …
       </title>
 
 
     <refsect2>
       <title>udevadm wait
-      <arg choice="opt"><replaceable>options</replaceable></arg>
-      <arg choice="opt"><replaceable>device|syspath</replaceable></arg>
+      <optional><replaceable>options</replaceable></optional>
+      <optional><replaceable>device|syspath</replaceable></optional>
       …
       </title>
 
 
     <refsect2>
       <title>udevadm lock
-      <arg choice="opt"><replaceable>options</replaceable></arg>
-      <arg choice="opt"><replaceable>command</replaceable></arg>
+      <optional><replaceable>options</replaceable></optional>
+      <optional><replaceable>command</replaceable></optional>
       …
       </title>
 
index 4d712d2d7caa633365d2efa2a6c6a9fa1036d418..f991ee3c06b8d5a1bafc9ed5c5acbbe920f6bd24 100644 (file)
 
         <varlistentry>
           <term><option>--section=<replaceable>NAME</replaceable>:<replaceable>TEXT</replaceable>|<replaceable>@PATH</replaceable></option></term>
-          <term><option>--section=<replaceable>NAME</replaceable>:<arg choice="plain">text|binary</arg><optional>@<replaceable>PATH</replaceable></optional></option></term>
+          <term><option>--section=<replaceable>NAME</replaceable>:text|binary<optional>@<replaceable>PATH</replaceable></optional></option></term>
 
           <listitem><para>For all verbs except <command>inspect</command>, the first syntax is used.
           Specify an arbitrary additional section <literal><replaceable>NAME</replaceable></literal>.
index bdc2aa22f11934c71007ab01624cc9b3e3ea028f..6d0eaa4e0451a932df977ff566e6a3e8b1e791f2 100644 (file)
@@ -3,7 +3,7 @@
   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
 
-<refentry id="user@.service">
+<refentry id="user_.service">
   <refentryinfo>
     <title>user@.service</title>
     <productname>systemd</productname>
index 579dd405c227a82fb58bf09568d7212a14c183cc..b4b262b508daf5ab110a542ac8c0a26c6193c984 100755 (executable)
@@ -46,7 +46,7 @@ This index contains {count} entries, referring to {pages} individual manual page
 
 def check_id(page, t):
     page_id = t.getroot().get('id')
-    if not re.search('/' + page_id + '[.]', page):
+    if not re.search('/' + page_id + '[.]', page.translate(str.maketrans('@', '_'))):
         raise ValueError(f"id='{page_id}' is not the same as page name '{page}'")
 
 def make_index(pages):