From bbd0645a3e9f10aaba8b9eead5bcce43f8080ab9 Mon Sep 17 00:00:00 2001 From: David Tardon Date: Sat, 23 Dec 2023 09:57:43 +0100 Subject: [PATCH 01/15] man: match doctype and root element --- man/cgroup-sandboxing.xml | 2 +- man/common-variables.xml | 2 +- man/libsystemd-pkgconfig.xml | 2 +- man/standard-options.xml | 2 +- man/standard-specifiers.xml | 2 +- man/supported-controllers.xml | 2 +- man/system-only.xml | 2 +- man/system-or-user-ns.xml | 2 +- man/tc.xml | 2 +- man/threads-aware.xml | 2 +- man/user-system-options.xml | 2 +- man/version-info.xml | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/man/cgroup-sandboxing.xml b/man/cgroup-sandboxing.xml index 56f7c4007b..d36a9b59d8 100644 --- a/man/cgroup-sandboxing.xml +++ b/man/cgroup-sandboxing.xml @@ -1,5 +1,5 @@ - + diff --git a/man/libsystemd-pkgconfig.xml b/man/libsystemd-pkgconfig.xml index 3d22870739..02e4b8fc72 100644 --- a/man/libsystemd-pkgconfig.xml +++ b/man/libsystemd-pkgconfig.xml @@ -1,5 +1,5 @@ - diff --git a/man/standard-options.xml b/man/standard-options.xml index eb27f5cb65..df71deaea9 100644 --- a/man/standard-options.xml +++ b/man/standard-options.xml @@ -1,5 +1,5 @@ - diff --git a/man/standard-specifiers.xml b/man/standard-specifiers.xml index 7aa7acaf60..3a2c0b0266 100644 --- a/man/standard-specifiers.xml +++ b/man/standard-specifiers.xml @@ -1,5 +1,5 @@ - diff --git a/man/supported-controllers.xml b/man/supported-controllers.xml index 61cdf468d9..27888ac9a5 100644 --- a/man/supported-controllers.xml +++ b/man/supported-controllers.xml @@ -1,5 +1,5 @@ - + diff --git a/man/user-system-options.xml b/man/user-system-options.xml index f3bafaea38..952ac18a4f 100644 --- a/man/user-system-options.xml +++ b/man/user-system-options.xml @@ -1,5 +1,5 @@ - diff --git a/man/version-info.xml b/man/version-info.xml index 5dabf9d31a..f55c0971b4 100644 --- a/man/version-info.xml +++ b/man/version-info.xml @@ -1,5 +1,5 @@ - From af355f198ef032b2af14537f84b1961e67cc9e37 Mon Sep 17 00:00:00 2001 From: David Tardon Date: Sat, 23 Dec 2023 10:05:38 +0100 Subject: [PATCH 02/15] man: add required --- man/cgroup-sandboxing.xml | 1 + man/standard-conf.xml | 2 ++ man/supported-controllers.xml | 1 + man/tc.xml | 2 ++ man/threads-aware.xml | 1 + man/version-info.xml | 2 ++ 6 files changed, 9 insertions(+) diff --git a/man/cgroup-sandboxing.xml b/man/cgroup-sandboxing.xml index d36a9b59d8..9499c9027a 100644 --- a/man/cgroup-sandboxing.xml +++ b/man/cgroup-sandboxing.xml @@ -6,6 +6,7 @@ --> <refsect1> + <title/> <para id="singular">This option cannot be bypassed by prefixing <literal>+</literal> to the executable path in the service unit, as it applies to the whole control group.</para> diff --git a/man/standard-conf.xml b/man/standard-conf.xml index cc2b874016..0174c090e9 100644 --- a/man/standard-conf.xml +++ b/man/standard-conf.xml @@ -8,6 +8,8 @@ --> <refsection> + <title/> + <refsection id='confd'> <title>Configuration Directories and Precedence diff --git a/man/supported-controllers.xml b/man/supported-controllers.xml index 27888ac9a5..62e05a6dc8 100644 --- a/man/supported-controllers.xml +++ b/man/supported-controllers.xml @@ -6,6 +6,7 @@ --> + <para id="controllers-text">The following controller names may be specified: <option>cpu</option>, <option>cpuacct</option>, <option>cpuset</option>, <option>io</option>, <option>blkio</option>, <option>memory</option>, <option>devices</option>, diff --git a/man/tc.xml b/man/tc.xml index 7c382480b3..f845b15881 100644 --- a/man/tc.xml +++ b/man/tc.xml @@ -6,6 +6,8 @@ --> <refsect1> + <title/> + <variablelist class='network-directives'> <varlistentry id='qdisc-parent'> <term><varname>Parent=</varname></term> diff --git a/man/threads-aware.xml b/man/threads-aware.xml index 7affbb2445..52c5c56acb 100644 --- a/man/threads-aware.xml +++ b/man/threads-aware.xml @@ -4,6 +4,7 @@ <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refsect1> + <title/> <para id="strict">All functions listed here are thread-agnostic and only a single specific thread may operate on a given object during its entire lifetime. It's safe to allocate multiple independent objects and use each from a diff --git a/man/version-info.xml b/man/version-info.xml index f55c0971b4..414172873d 100644 --- a/man/version-info.xml +++ b/man/version-info.xml @@ -4,6 +4,8 @@ <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refsect1> + <title/> + <para id="v183">Added in version 183.</para> <para id="v184">Added in version 184.</para> <para id="v185">Added in version 185.</para> From 35fc10756bc5302d2dff1c235f864fa23a6d8771 Mon Sep 17 00:00:00 2001 From: David Tardon <dtardon@redhat.com> Date: Sat, 23 Dec 2023 11:19:52 +0100 Subject: [PATCH 03/15] man: add missing <cmdsynopsis> wrapper --- man/busctl.xml | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/man/busctl.xml b/man/busctl.xml index cc404529ae..835724eb20 100644 --- a/man/busctl.xml +++ b/man/busctl.xml @@ -44,7 +44,7 @@ <variablelist> <varlistentry> - <term><command>list</command></term> + <term><cmdsynopsis><command>list</command></cmdsynopsis></term> <listitem><para>Show all peers on the bus, by their service names. By default, shows both unique and well-known names, but @@ -56,7 +56,7 @@ </varlistentry> <varlistentry> - <term><command>status</command> <arg choice="opt"><replaceable>SERVICE</replaceable></arg></term> + <term><cmdsynopsis><command>status</command> <arg choice="opt"><replaceable>SERVICE</replaceable></arg></cmdsynopsis></term> <listitem><para>Show process information and credentials of a bus service (if one is specified by its unique or well-known @@ -68,7 +68,7 @@ </varlistentry> <varlistentry> - <term><command>monitor</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term> + <term><cmdsynopsis><command>monitor</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></cmdsynopsis></term> <listitem><para>Dump messages being exchanged. If <replaceable>SERVICE</replaceable> is specified, show messages @@ -81,7 +81,7 @@ </varlistentry> <varlistentry> - <term><command>capture</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term> + <term><cmdsynopsis><command>capture</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></cmdsynopsis></term> <listitem><para>Similar to <command>monitor</command> but writes the output in pcapng format (for details, see @@ -96,7 +96,7 @@ </varlistentry> <varlistentry> - <term><command>tree</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></term> + <term><cmdsynopsis><command>tree</command> <arg choice="opt" rep="repeat"><replaceable>SERVICE</replaceable></arg></cmdsynopsis></term> <listitem><para>Shows an object tree of one or more services. If <replaceable>SERVICE</replaceable> is specified, @@ -108,7 +108,7 @@ </varlistentry> <varlistentry> - <term><command>introspect</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg> <arg choice="plain"><replaceable>OBJECT</replaceable></arg> <arg choice="opt"><replaceable>INTERFACE</replaceable></arg></term> + <term><cmdsynopsis><command>introspect</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg> <arg choice="plain"><replaceable>OBJECT</replaceable></arg> <arg choice="opt"><replaceable>INTERFACE</replaceable></arg></cmdsynopsis></term> <listitem><para>Show interfaces, methods, properties and signals of the specified object (identified by its path) on @@ -120,7 +120,7 @@ </varlistentry> <varlistentry> - <term><command>call</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg> <arg choice="plain"><replaceable>OBJECT</replaceable></arg> <arg choice="plain"><replaceable>INTERFACE</replaceable></arg> <arg choice="plain"><replaceable>METHOD</replaceable></arg> <arg choice="opt"><replaceable>SIGNATURE</replaceable> <arg choice="opt" rep="repeat"><replaceable>ARGUMENT</replaceable></arg></arg></term> + <term><cmdsynopsis><command>call</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg> <arg choice="plain"><replaceable>OBJECT</replaceable></arg> <arg choice="plain"><replaceable>INTERFACE</replaceable></arg> <arg choice="plain"><replaceable>METHOD</replaceable></arg> <arg choice="opt"><replaceable>SIGNATURE</replaceable> <arg choice="opt" rep="repeat"><replaceable>ARGUMENT</replaceable></arg></arg></cmdsynopsis></term> <listitem><para>Invoke a method and show the response. Takes a service name, object path, interface name and method name. If @@ -134,7 +134,7 @@ </varlistentry> <varlistentry> - <term><command>emit</command> <arg choice="plain"><replaceable>OBJECT</replaceable></arg> <arg choice="plain"><replaceable>INTERFACE</replaceable></arg> <arg choice="plain"><replaceable>SIGNAL</replaceable></arg> <arg choice="opt"><replaceable>SIGNATURE</replaceable> <arg choice="opt" rep="repeat"><replaceable>ARGUMENT</replaceable></arg></arg></term> + <term><cmdsynopsis><command>emit</command> <arg choice="plain"><replaceable>OBJECT</replaceable></arg> <arg choice="plain"><replaceable>INTERFACE</replaceable></arg> <arg choice="plain"><replaceable>SIGNAL</replaceable></arg> <arg choice="opt"><replaceable>SIGNATURE</replaceable> <arg choice="opt" rep="repeat"><replaceable>ARGUMENT</replaceable></arg></arg></cmdsynopsis></term> <listitem><para>Emit a signal. Takes an object path, interface name and method name. If parameters shall be passed, a signature string is required, followed by the arguments, individually formatted as @@ -145,7 +145,7 @@ </varlistentry> <varlistentry> - <term><command>get-property</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg> <arg choice="plain"><replaceable>OBJECT</replaceable></arg> <arg choice="plain"><replaceable>INTERFACE</replaceable></arg> <arg choice="plain" rep="repeat"><replaceable>PROPERTY</replaceable></arg></term> + <term><cmdsynopsis><command>get-property</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg> <arg choice="plain"><replaceable>OBJECT</replaceable></arg> <arg choice="plain"><replaceable>INTERFACE</replaceable></arg> <arg choice="plain" rep="repeat"><replaceable>PROPERTY</replaceable></arg></cmdsynopsis></term> <listitem><para>Retrieve the current value of one or more object properties. Takes a service name, object path, @@ -159,7 +159,7 @@ </varlistentry> <varlistentry> - <term><command>set-property</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg> <arg choice="plain"><replaceable>OBJECT</replaceable></arg> <arg choice="plain"><replaceable>INTERFACE</replaceable></arg> <arg choice="plain"><replaceable>PROPERTY</replaceable></arg> <arg choice="plain"><replaceable>SIGNATURE</replaceable></arg> <arg choice="plain" rep="repeat"><replaceable>ARGUMENT</replaceable></arg></term> + <term><cmdsynopsis><command>set-property</command> <arg choice="plain"><replaceable>SERVICE</replaceable></arg> <arg choice="plain"><replaceable>OBJECT</replaceable></arg> <arg choice="plain"><replaceable>INTERFACE</replaceable></arg> <arg choice="plain"><replaceable>PROPERTY</replaceable></arg> <arg choice="plain"><replaceable>SIGNATURE</replaceable></arg> <arg choice="plain" rep="repeat"><replaceable>ARGUMENT</replaceable></arg></cmdsynopsis></term> <listitem><para>Set the current value of an object property. Takes a service name, object path, interface name, @@ -170,7 +170,7 @@ </varlistentry> <varlistentry> - <term><command>help</command></term> + <term><cmdsynopsis><command>help</command></cmdsynopsis></term> <listitem><para>Show command syntax help.</para> From a5fcbfea45c535d743b805683f643dc97fc39b59 Mon Sep 17 00:00:00 2001 From: David Tardon <dtardon@redhat.com> Date: Sat, 23 Dec 2023 12:25:06 +0100 Subject: [PATCH 04/15] man: add missing <listitem> --- man/common-variables.xml | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/man/common-variables.xml b/man/common-variables.xml index 97bf911bb2..35ac98048f 100644 --- a/man/common-variables.xml +++ b/man/common-variables.xml @@ -116,24 +116,28 @@ <varlistentry> <term><option>K</option></term> - <para>This option instructs the pager to exit immediately when - <keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo> is pressed. To allow - <command>less</command> to handle <keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo> - itself to switch back to the pager command prompt, unset this option.</para> + <listitem> + <para>This option instructs the pager to exit immediately when + <keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo> is pressed. To allow + <command>less</command> to handle <keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo> + itself to switch back to the pager command prompt, unset this option.</para> - <para>If the value of <varname>$SYSTEMD_LESS</varname> does not include <literal>K</literal>, - and the pager that is invoked is <command>less</command>, - <keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo> will be ignored by the - executable, and needs to be handled by the pager.</para> + <para>If the value of <varname>$SYSTEMD_LESS</varname> does not include <literal>K</literal>, + and the pager that is invoked is <command>less</command>, + <keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo> will be ignored by the + executable, and needs to be handled by the pager.</para> + </listitem> </varlistentry> <varlistentry> <term><option>X</option></term> - <para>This option instructs the pager to not send termcap initialization and deinitialization - strings to the terminal. It is set by default to allow command output to remain visible in the - terminal even after the pager exits. Nevertheless, this prevents some pager functionality from - working, in particular paged output cannot be scrolled with the mouse.</para> + <listitem> + <para>This option instructs the pager to not send termcap initialization and deinitialization + strings to the terminal. It is set by default to allow command output to remain visible in the + terminal even after the pager exits. Nevertheless, this prevents some pager functionality from + working, in particular paged output cannot be scrolled with the mouse.</para> + </listitem> </varlistentry> </variablelist> From d9655d11bcdc91b3c91db7e2e2f76d46c030784d Mon Sep 17 00:00:00 2001 From: David Tardon <dtardon@redhat.com> Date: Sat, 23 Dec 2023 13:25:57 +0100 Subject: [PATCH 05/15] man: move </listitem> to the right position --- man/journald.conf.xml | 3 ++- man/portablectl.xml | 8 ++++---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/man/journald.conf.xml b/man/journald.conf.xml index 634cec4b52..53216d04d3 100644 --- a/man/journald.conf.xml +++ b/man/journald.conf.xml @@ -387,7 +387,7 @@ <para>When forwarding to the kernel log buffer (kmsg), make sure to select a suitably large size for the log buffer, for example by adding <literal>log_buf_len=8M</literal> to the kernel command line. <command>systemd</command> will automatically disable kernel's rate-limiting applied to userspace - processes (equivalent to setting <literal>printk.devkmsg=on</literal>).</para></listitem> + processes (equivalent to setting <literal>printk.devkmsg=on</literal>).</para> <para>Note: Forwarding is performed synchronously within journald, and may significantly affect its performance. This is particularly relevant when using ForwardToConsole=yes in cloud environments, @@ -397,6 +397,7 @@ journal also becoming blocked. Unless actively debugging/developing something, it's generally preferable to setup a <command>journalctl --follow</command> style service redirected to the console, instead of ForwardToConsole=yes, for production use.</para> + </listitem> </varlistentry> <varlistentry> diff --git a/man/portablectl.xml b/man/portablectl.xml index 03ca65e0cb..c252cae20e 100644 --- a/man/portablectl.xml +++ b/man/portablectl.xml @@ -155,11 +155,11 @@ files. This is a convenience feature to allow all arguments passed as <command>attach</command> also to <command>detach</command>.</para> - <xi:include href="version-info.xml" xpointer="v239"/></listitem> - <para>If <option>--now</option> and/or <option>--enable</option> are passed, the portable services are immediately stopped (blocking operation) and/or disabled before detaching the image. Prefix(es) are also accepted, to be used in case the unit names do not match the image name as described in the <command>attach</command>.</para> + + <xi:include href="version-info.xml" xpointer="v239"/></listitem> </varlistentry> <varlistentry> @@ -171,11 +171,11 @@ character has to match. If the new image doesn't exist, the existing one will not be detached. The parameters follow the same syntax as the <command>attach</command> command.</para> - <xi:include href="version-info.xml" xpointer="v248"/></listitem> - <para>If <option>--now</option> and/or <option>--enable</option> are passed, the portable services are immediately stopped if removed, started and/or enabled if added, or restarted if updated. Prefixes are also accepted, in the same way as described in the <command>attach</command> case.</para> + + <xi:include href="version-info.xml" xpointer="v248"/></listitem> </varlistentry> <varlistentry> From 35fcba4a8ca9a01fa4e4b81dde88591f9335b61d Mon Sep 17 00:00:00 2001 From: David Tardon <dtardon@redhat.com> Date: Sat, 23 Dec 2023 13:38:40 +0100 Subject: [PATCH 06/15] man: move misplaced </varlistentry> --- man/networkctl.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/man/networkctl.xml b/man/networkctl.xml index 1a03e9e11d..05d2654346 100644 --- a/man/networkctl.xml +++ b/man/networkctl.xml @@ -576,6 +576,7 @@ s - Service VLAN, m - Two-port MAC Relay (TPMR) <xi:include href="version-info.xml" xpointer="v254"/> </listitem> + </varlistentry> <varlistentry> <term><option>--runtime</option></term> @@ -587,7 +588,6 @@ s - Service VLAN, m - Two-port MAC Relay (TPMR) <xi:include href="version-info.xml" xpointer="v256"/> </listitem> </varlistentry> - </varlistentry> <xi:include href="standard-options.xml" xpointer="json" /> <xi:include href="standard-options.xml" xpointer="help" /> From 7a0f2298b84c416cace4896d262d8b55b17490ec Mon Sep 17 00:00:00 2001 From: David Tardon <dtardon@redhat.com> Date: Sat, 23 Dec 2023 13:46:39 +0100 Subject: [PATCH 07/15] man: wrap the whole description in <listitem> Unfortunately, version-info includes and standard-options includes are not composable... --- man/poweroff.xml | 6 ++++-- man/standard-options.xml | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/man/poweroff.xml b/man/poweroff.xml index 4abfa18bf7..5cbd52a94a 100644 --- a/man/poweroff.xml +++ b/man/poweroff.xml @@ -55,9 +55,11 @@ <varlistentry> <term><option>--help</option></term> - <xi:include href="standard-options.xml" xpointer="help-text" /> + <listitem> + <xi:include href="standard-options.xml" xpointer="help-para" /> - <xi:include href="version-info.xml" xpointer="v253"/> + <xi:include href="version-info.xml" xpointer="v253"/> + </listitem> </varlistentry> <varlistentry> diff --git a/man/standard-options.xml b/man/standard-options.xml index df71deaea9..aec9a0d750 100644 --- a/man/standard-options.xml +++ b/man/standard-options.xml @@ -11,7 +11,7 @@ <term><option>--help</option></term> <listitem id='help-text'> - <para>Print a short help text and exit. + <para id='help-para'>Print a short help text and exit. </para></listitem> </varlistentry> From 08b96745ddea8d1a7226316098a0a5651ff312dc Mon Sep 17 00:00:00 2001 From: David Tardon <dtardon@redhat.com> Date: Sat, 23 Dec 2023 14:01:02 +0100 Subject: [PATCH 08/15] man: use just one <listitem> for the description <varlistentry> allows one or more <term>s, but exactly one <listitem>. --- man/sd_bus_call.xml | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/man/sd_bus_call.xml b/man/sd_bus_call.xml index 0bd863d604..963cc25d63 100644 --- a/man/sd_bus_call.xml +++ b/man/sd_bus_call.xml @@ -122,22 +122,24 @@ <varlistentry> <term><constant>-EINVAL</constant></term> - <listitem><para>The input parameter <parameter>m</parameter> is <constant>NULL</constant>. - </para> + <listitem> + <para>The input parameter <parameter>m</parameter> is <constant>NULL</constant>. + </para> - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <para>The input parameter <parameter>m</parameter> is not a D-Bus method call. + To create a new D-Bus method call, use + <citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>. + </para> - <listitem><para>The input parameter <parameter>m</parameter> is not a D-Bus method call. - To create a new D-Bus method call, use - <citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>. - </para></listitem> + <para>The input parameter <parameter>m</parameter> has the + <constant>BUS_MESSAGE_NO_REPLY_EXPECTED</constant> flag set.</para> - <listitem><para>The input parameter <parameter>m</parameter> has the - <constant>BUS_MESSAGE_NO_REPLY_EXPECTED</constant> flag set.</para></listitem> + <para>The input parameter <parameter>error</parameter> is + non-<constant>NULL</constant> but was not set to <constant>SD_BUS_ERROR_NULL</constant>. + </para> - <listitem><para>The input parameter <parameter>error</parameter> is - non-<constant>NULL</constant> but was not set to <constant>SD_BUS_ERROR_NULL</constant>. - </para></listitem> + <xi:include href="version-info.xml" xpointer="v246"/> + </listitem> </varlistentry> <varlistentry> From 3c2b711f4a91fd92f7ec99d90d967f6eb398eaa7 Mon Sep 17 00:00:00 2001 From: David Tardon <dtardon@redhat.com> Date: Sat, 23 Dec 2023 14:58:45 +0100 Subject: [PATCH 09/15] man: wrap sentinel in <parameter> --- man/sd-id128.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/man/sd-id128.xml b/man/sd-id128.xml index d264220b0b..082e418519 100644 --- a/man/sd-id128.xml +++ b/man/sd-id128.xml @@ -102,7 +102,7 @@ <funcdef>int <function>sd_id128_in_set_sentinel</function></funcdef> <paramdef>sd_id128_t <parameter>id</parameter></paramdef> <paramdef>…</paramdef> - <paramdef><constant>SD_ID128_NULL</constant></paramdef> + <paramdef><parameter><constant>SD_ID128_NULL</constant></parameter></paramdef> </funcprototype> <funcprototype> From 5b297dcec8110efe1bc8e7c5cae5a7ac5de59e8f Mon Sep 17 00:00:00 2001 From: David Tardon <dtardon@redhat.com> Date: Sat, 23 Dec 2023 18:08:34 +0100 Subject: [PATCH 10/15] man: drop stray empty paragraph --- man/veritytab.xml | 1 - 1 file changed, 1 deletion(-) diff --git a/man/veritytab.xml b/man/veritytab.xml index bc9aa58f8c..905e8151f8 100644 --- a/man/veritytab.xml +++ b/man/veritytab.xml @@ -129,7 +129,6 @@ This is based on crypttab(5). provided in standard UUID format, e.g. 12345678-1234-1234-1234-123456789abc.</para> <xi:include href="version-info.xml" xpointer="v254"/></listitem> - <listitem><para></para></listitem> </varlistentry> <varlistentry> From 1eb07e6ffa4ae9ad33938353b4701efac7cd7b25 Mon Sep 17 00:00:00 2001 From: David Tardon <dtardon@redhat.com> Date: Sat, 23 Dec 2023 15:21:58 +0100 Subject: [PATCH 11/15] man: fix markup --- man/systemd-ask-password.xml | 2 +- man/telinit.xml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/man/systemd-ask-password.xml b/man/systemd-ask-password.xml index 5bae448343..a38f980e9b 100644 --- a/man/systemd-ask-password.xml +++ b/man/systemd-ask-password.xml @@ -23,7 +23,7 @@ <refsynopsisdiv> <cmdsynopsis> - <command>systemd-ask-password <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">MESSAGE</arg></command> + <command>systemd-ask-password</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">MESSAGE</arg> </cmdsynopsis> </refsynopsisdiv> diff --git a/man/telinit.xml b/man/telinit.xml index 294b359a3a..35c2598008 100644 --- a/man/telinit.xml +++ b/man/telinit.xml @@ -23,7 +23,7 @@ <refsynopsisdiv> <cmdsynopsis> - <command>telinit <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMAND</arg></command> + <command>telinit</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMAND</arg> </cmdsynopsis> </refsynopsisdiv> From b2e6aae6741a54f136afcb6c3951d589ae155d90 Mon Sep 17 00:00:00 2001 From: David Tardon <dtardon@redhat.com> Date: Sat, 23 Dec 2023 15:40:42 +0100 Subject: [PATCH 12/15] man: fix option value --- man/systemd.generator.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/man/systemd.generator.xml b/man/systemd.generator.xml index 06fe7ec9d9..95c84b9ede 100644 --- a/man/systemd.generator.xml +++ b/man/systemd.generator.xml @@ -26,8 +26,8 @@ <cmdsynopsis> <command index='false'>/path/to/generator</command> <arg choice="plain"><replaceable>normal-dir</replaceable></arg> - <arg choice="option"><replaceable>early-dir</replaceable></arg> - <arg choice="option"><replaceable>late-dir</replaceable></arg> + <arg choice="opt"><replaceable>early-dir</replaceable></arg> + <arg choice="opt"><replaceable>late-dir</replaceable></arg> </cmdsynopsis> <para><simplelist> From 74cd284ad0e89266fe1f03e0daf772a04aa5f737 Mon Sep 17 00:00:00 2001 From: David Tardon <dtardon@redhat.com> Date: Sat, 23 Dec 2023 16:04:11 +0100 Subject: [PATCH 13/15] man: fix markup --- man/systemd.net-naming-scheme.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/man/systemd.net-naming-scheme.xml b/man/systemd.net-naming-scheme.xml index e2e8a0919a..209aa3ee5c 100644 --- a/man/systemd.net-naming-scheme.xml +++ b/man/systemd.net-naming-scheme.xml @@ -223,7 +223,7 @@ </table> <para>The PCI domain is only prepended when it is not 0. All multi-function PCI devices will carry - the <constant>f<replaceable>function</replaceable></constant> number in the device name, including + the <constant>f</constant><replaceable>function</replaceable> number in the device name, including the function 0 device. For non-multi-function devices, the number is suppressed if 0. The port name <replaceable>port_name</replaceable> is used, or the port number <constant>d</constant><replaceable>dev_port</replaceable> if the name is not known.</para> From 74512bbc38fcac6218b525ff7a9a8ad310f9942b Mon Sep 17 00:00:00 2001 From: David Tardon <dtardon@redhat.com> Date: Sat, 23 Dec 2023 16:39:37 +0100 Subject: [PATCH 14/15] man: use the right element for untitled example --- man/systemd.syntax.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/man/systemd.syntax.xml b/man/systemd.syntax.xml index 2fc22885ca..a0d63f994d 100644 --- a/man/systemd.syntax.xml +++ b/man/systemd.syntax.xml @@ -89,7 +89,7 @@ file type. When a comment line or lines follow a line ending with a backslash, the comment block is ignored, so the continued line is concatenated with whatever follows the comment block.</para> - <example><programlisting>[Section A] + <informalexample><programlisting>[Section A] KeyOne=value 1 KeyTwo=value 2 @@ -105,7 +105,7 @@ KeyThree=value 3\ # this line is ignored ; this line is ignored too value 3 continued -</programlisting></example> +</programlisting></informalexample> <para>Boolean arguments used in configuration files can be written in various formats. For positive settings the strings From 7e59b569a19d47b84f0616ab0303d012bc5694ef Mon Sep 17 00:00:00 2001 From: David Tardon <dtardon@redhat.com> Date: Sun, 24 Dec 2023 10:46:55 +0100 Subject: [PATCH 15/15] man: adjust indentation --- man/cgroup-sandboxing.xml | 8 ++++---- man/supported-controllers.xml | 6 +++--- man/threads-aware.xml | 24 ++++++++++++------------ 3 files changed, 19 insertions(+), 19 deletions(-) diff --git a/man/cgroup-sandboxing.xml b/man/cgroup-sandboxing.xml index 9499c9027a..c9e068f887 100644 --- a/man/cgroup-sandboxing.xml +++ b/man/cgroup-sandboxing.xml @@ -8,10 +8,10 @@ <refsect1> <title/> -<para id="singular">This option cannot be bypassed by prefixing <literal>+</literal> to the executable path -in the service unit, as it applies to the whole control group.</para> + <para id="singular">This option cannot be bypassed by prefixing <literal>+</literal> to the executable path + in the service unit, as it applies to the whole control group.</para> -<para id="plural">These options cannot be bypassed by prefixing <literal>+</literal> to the executable path -in the service unit, as it applies to the whole control group.</para> + <para id="plural">These options cannot be bypassed by prefixing <literal>+</literal> to the executable path + in the service unit, as it applies to the whole control group.</para> </refsect1> diff --git a/man/supported-controllers.xml b/man/supported-controllers.xml index 62e05a6dc8..3ec06939e6 100644 --- a/man/supported-controllers.xml +++ b/man/supported-controllers.xml @@ -8,8 +8,8 @@ <refsect1> <title/> -<para id="controllers-text">The following controller names may be specified: <option>cpu</option>, <option>cpuacct</option>, -<option>cpuset</option>, <option>io</option>, <option>blkio</option>, <option>memory</option>, <option>devices</option>, -<option>pids</option>, <option>bpf-firewall</option>, and <option>bpf-devices</option>.</para> + <para id="controllers-text">The following controller names may be specified: <option>cpu</option>, <option>cpuacct</option>, + <option>cpuset</option>, <option>io</option>, <option>blkio</option>, <option>memory</option>, <option>devices</option>, + <option>pids</option>, <option>bpf-firewall</option>, and <option>bpf-devices</option>.</para> </refsect1> diff --git a/man/threads-aware.xml b/man/threads-aware.xml index 52c5c56acb..bb39266626 100644 --- a/man/threads-aware.xml +++ b/man/threads-aware.xml @@ -6,19 +6,19 @@ <refsect1> <title/> -<para id="strict">All functions listed here are thread-agnostic and only a single specific thread may operate on a -given object during its entire lifetime. It's safe to allocate multiple independent objects and use each from a -specific thread in parallel. However, it's not safe to allocate such an object in one thread, and operate or free it -from any other, even if locking is used to ensure these threads don't operate on it at the very same time.</para> + <para id="strict">All functions listed here are thread-agnostic and only a single specific thread may operate on a + given object during its entire lifetime. It's safe to allocate multiple independent objects and use each from a + specific thread in parallel. However, it's not safe to allocate such an object in one thread, and operate or free it + from any other, even if locking is used to ensure these threads don't operate on it at the very same time.</para> -<para id="safe">All functions listed here are thread-safe and may be called in parallel from multiple threads.</para> + <para id="safe">All functions listed here are thread-safe and may be called in parallel from multiple threads.</para> -<para id='getenv'>The code described here uses -<citerefentry project='man-pages'><refentrytitle>getenv</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -which is declared to be not multi-thread-safe. This means that the code calling the functions described -here must not call -<citerefentry project='man-pages'><refentrytitle>setenv</refentrytitle><manvolnum>3</manvolnum></citerefentry> -from a parallel thread. It is recommended to only do calls to <function>setenv()</function> -from an early phase of the program when no other threads have been started.</para> + <para id='getenv'>The code described here uses + <citerefentry project='man-pages'><refentrytitle>getenv</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + which is declared to be not multi-thread-safe. This means that the code calling the functions described + here must not call + <citerefentry project='man-pages'><refentrytitle>setenv</refentrytitle><manvolnum>3</manvolnum></citerefentry> + from a parallel thread. It is recommended to only do calls to <function>setenv()</function> + from an early phase of the program when no other threads have been started.</para> </refsect1>