From df93996fd658345ed74c33ac901f2e8355f35033 Mon Sep 17 00:00:00 2001 From: David Tardon Date: Sat, 23 Dec 2023 15:09:50 +0100 Subject: [PATCH 1/9] man: drop output redir. from cmd. synopsis doesn't allow inline content, like the redir. operator here. And std. output is not an argument anyway... --- man/systemd-analyze.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/man/systemd-analyze.xml b/man/systemd-analyze.xml index 6f6f021f30..68062049c4 100644 --- a/man/systemd-analyze.xml +++ b/man/systemd-analyze.xml @@ -177,7 +177,7 @@ systemd-analyze OPTIONS - srk >FILE + srk systemd-analyze From d2c0c05f51b2e7e64cf99f6ce66d402047360f69 Mon Sep 17 00:00:00 2001 From: David Tardon Date: Sat, 23 Dec 2023 16:33:53 +0100 Subject: [PATCH 2/9] man: add an extra DocBook's document model doesn't allow block content after a section. --- man/systemd.resource-control.xml | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/man/systemd.resource-control.xml b/man/systemd.resource-control.xml index fee4971a97..298ba8f9c4 100644 --- a/man/systemd.resource-control.xml +++ b/man/systemd.resource-control.xml @@ -151,10 +151,13 @@ CPUWeight=20 DisableControllers=cpu / \ applies to all user slices. - See the New - Control Group Interfaces for an introduction on how to make - use of resource control APIs from programs. + + + <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> From c101b65619e754059c3183f822132f1915df46de Mon Sep 17 00:00:00 2001 From: David Tardon <dtardon@redhat.com> Date: Sat, 23 Dec 2023 17:22:04 +0100 Subject: [PATCH 3/9] man: make ID valid The id attribute is of type ID, defined at https://www.w3.org/TR/1998/REC-xml-19980210#id . It may contain only selected non-alphanumeric characters; '@' is not among them. --- man/systemd-backlight@.service.xml | 2 +- man/systemd-fsck@.service.xml | 2 +- man/systemd-integritysetup@.service.xml | 2 +- man/systemd-makefs@.service.xml | 2 +- man/systemd-veritysetup@.service.xml | 2 +- man/user@.service.xml | 2 +- tools/make-man-index.py | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/man/systemd-backlight@.service.xml b/man/systemd-backlight@.service.xml index 431b27bbb0..95fa518bff 100644 --- a/man/systemd-backlight@.service.xml +++ b/man/systemd-backlight@.service.xml @@ -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> diff --git a/man/systemd-fsck@.service.xml b/man/systemd-fsck@.service.xml index 5f351ded35..a138bd0107 100644 --- a/man/systemd-fsck@.service.xml +++ b/man/systemd-fsck@.service.xml @@ -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 diff --git a/man/systemd-integritysetup@.service.xml b/man/systemd-integritysetup@.service.xml index a090b1c763..831c3690e1 100644 --- a/man/systemd-integritysetup@.service.xml +++ b/man/systemd-integritysetup@.service.xml @@ -3,7 +3,7 @@ - diff --git a/man/systemd-makefs@.service.xml b/man/systemd-makefs@.service.xml index 0b54ba3584..5447de0405 100644 --- a/man/systemd-makefs@.service.xml +++ b/man/systemd-makefs@.service.xml @@ -3,7 +3,7 @@ - + systemd-makefs@.service diff --git a/man/systemd-veritysetup@.service.xml b/man/systemd-veritysetup@.service.xml index 4a4d8d9814..a549b41b70 100644 --- a/man/systemd-veritysetup@.service.xml +++ b/man/systemd-veritysetup@.service.xml @@ -3,7 +3,7 @@ - diff --git a/man/user@.service.xml b/man/user@.service.xml index bdc2aa22f1..6d0eaa4e04 100644 --- a/man/user@.service.xml +++ b/man/user@.service.xml @@ -3,7 +3,7 @@ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> - + user@.service systemd diff --git a/tools/make-man-index.py b/tools/make-man-index.py index 579dd405c2..b4b262b508 100755 --- a/tools/make-man-index.py +++ b/tools/make-man-index.py @@ -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): From 1ab6ecd109729d52cd3452cd9ff5e84961d56e15 Mon Sep 17 00:00:00 2001 From: David Tardon Date: Sat, 23 Dec 2023 17:34:30 +0100 Subject: [PATCH 4/9] man: fix markup is not allowed inside . --- man/udevadm.xml | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/man/udevadm.xml b/man/udevadm.xml index a9a4a4c374..9932f14b9f 100644 --- a/man/udevadm.xml +++ b/man/udevadm.xml @@ -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> Query the udev database for device information. @@ -382,8 +382,8 @@ 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> Request device events from the kernel. Primarily used to replay events at system coldplug time. @@ -607,7 +607,7 @@ udevadm settle - <arg choice="opt"><replaceable>options</replaceable></arg> + <optional><replaceable>options</replaceable></optional> Watches the udev event queue, and exits if all current events are handled. @@ -730,7 +730,7 @@ udevadm monitor - <arg choice="opt"><replaceable>options</replaceable></arg> + <optional><replaceable>options</replaceable></optional> 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 @@ -782,8 +782,8 @@ 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> Simulate a udev event run for the given device, and print debug output. @@ -819,9 +819,9 @@ 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> Run a built-in command COMMAND for device DEVPATH, and print debug @@ -848,8 +848,8 @@ 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> … @@ -913,8 +913,8 @@ 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> … @@ -977,8 +977,8 @@ 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> … From eb066221e921633470d0df8c57c60ab28e1cc4db Mon Sep 17 00:00:00 2001 From: David Tardon Date: Sat, 23 Dec 2023 17:34:30 +0100 Subject: [PATCH 5/9] man: fix markup is not allowed inside . --- man/ukify.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/man/ukify.xml b/man/ukify.xml index 4d712d2d7c..f991ee3c06 100644 --- a/man/ukify.xml +++ b/man/ukify.xml @@ -203,7 +203,7 @@ <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>. From e353998eb6af4c82751fb06d774002b8e1b679e3 Mon Sep 17 00:00:00 2001 From: David Tardon <dtardon@redhat.com> Date: Sun, 24 Dec 2023 10:39:08 +0100 Subject: [PATCH 6/9] man: fix markup --- man/systemd.net-naming-scheme.xml | 38 +++++++++++++++---------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/man/systemd.net-naming-scheme.xml b/man/systemd.net-naming-scheme.xml index 07ab26e6f6..ed1c5ec46b 100644 --- a/man/systemd.net-naming-scheme.xml +++ b/man/systemd.net-naming-scheme.xml @@ -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 @@ -135,7 +135,7 @@ </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 @@ -147,7 +147,7 @@ </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 @@ -159,13 +159,13 @@ </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 @@ -251,13 +251,13 @@ </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 @@ -542,7 +542,7 @@ <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 From 9e25422299ddcdf79c38c303bcad814accd60a99 Mon Sep 17 00:00:00 2001 From: David Tardon <dtardon@redhat.com> Date: Sun, 24 Dec 2023 11:08:40 +0100 Subject: [PATCH 7/9] man: move macro decls. out of <funcsynopsis> <funcsynopsis> doesn't allow block content. --- man/sd_bus_add_object.xml | 234 +++++++++++++++++++------------------- 1 file changed, 117 insertions(+), 117 deletions(-) diff --git a/man/sd_bus_add_object.xml b/man/sd_bus_add_object.xml index b73ddc815a..7801f8825f 100644 --- a/man/sd_bus_add_object.xml +++ b/man/sd_bus_add_object.xml @@ -121,124 +121,124 @@ <paramdef>sd_bus_message_handler_t <parameter>callback</parameter></paramdef> <paramdef>void *<parameter>userdata</parameter></paramdef> </funcprototype> - - <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_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> </refsynopsisdiv> <refsect1> From cfcdee7c16f4b3cda238788dc841bfbddf3f15cb Mon Sep 17 00:00:00 2001 From: David Tardon <dtardon@redhat.com> Date: Mon, 25 Dec 2023 10:42:55 +0100 Subject: [PATCH 8/9] man: drop an extra <member> Follow-up for 13a69c120bc584e90f863f821710b3b5294cd206 . --- man/systemd.resource-control.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/man/systemd.resource-control.xml b/man/systemd.resource-control.xml index 298ba8f9c4..a86907b2bb 100644 --- a/man/systemd.resource-control.xml +++ b/man/systemd.resource-control.xml @@ -1672,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> From bc6fdcbf5d2c053ee0d27b713fa5e09cace9b44f Mon Sep 17 00:00:00 2001 From: David Tardon <dtardon@redhat.com> Date: Mon, 25 Dec 2023 10:50:13 +0100 Subject: [PATCH 9/9] man: use <refsect1> instead of <refsection> DocBook document model doesn't allow mixing of <refsection> with the numbered variants (<refsect1> etc.). Therefore, any document that included something from standard-conf.xml was invalid. Fortunately, all the includes are at the 1st level, hence let's just change standard-conf.xml to use <refsect1> to fix that. --- man/standard-conf.xml | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/man/standard-conf.xml b/man/standard-conf.xml index 0174c090e9..2f56c95fbb 100644 --- a/man/standard-conf.xml +++ b/man/standard-conf.xml @@ -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 Configuration files are read from directories in /etc/, @@ -38,9 +41,9 @@ way is to place a symlink to /dev/null in the configuration directory in /etc/, 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. - + - + Configuration Directories and Precedence The default configuration is set during compilation, so configuration is only needed when it is @@ -72,5 +75,5 @@ To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to /dev/null in the configuration directory in /etc/, with the same filename as the vendor configuration file. - - + +