Skip to content

Commit

Permalink
man: drop whitespace from final <programlisting> lines
Browse files Browse the repository at this point in the history
In the troff output, this doesn't seem to make any difference. But in the
html output, the whitespace is sometimes preserved, creating an additional
gap before the following content. Drop it everywhere to avoid this.
  • Loading branch information
keszybz committed Nov 8, 2024
1 parent 56f9a56 commit fe45f8d
Show file tree
Hide file tree
Showing 44 changed files with 146 additions and 145 deletions.
2 changes: 1 addition & 1 deletion man/environment.d.xml
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@
PATH=/opt/foo/bin:$PATH
LD_LIBRARY_PATH=/opt/foo/lib${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}
XDG_DATA_DIRS=/opt/foo/share:${XDG_DATA_DIRS:-/usr/local/share/:/usr/share/}
</programlisting>
</programlisting>
</example>
</refsect2>
</refsect1>
Expand Down
2 changes: 1 addition & 1 deletion man/libsystemd.xml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
#include &lt;systemd/sd-messages.h&gt;
#include &lt;systemd/sd-path.h&gt;
#include &lt;systemd/sd-varlink.h&gt;
</programlisting>
</programlisting>

<cmdsynopsis>
<command>pkg-config --cflags --libs libsystemd</command>
Expand Down
4 changes: 2 additions & 2 deletions man/loader.conf.xml
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@ attr=NON_VOLATILE,RUNTIME_ACCESS,BOOTSERVICE_ACCESS,TIME_BASED_AUTHENTICATED_WRI
sbvarsign --attr "${attr}" --key PK.key --cert PK.pem --output PK.auth PK PK.esl
sbvarsign --attr "${attr}" --key PK.key --cert PK.pem --output KEK.auth KEK KEK.esl
sbvarsign --attr "${attr}" --key KEK.key --cert KEK.pem --output db.auth db db.esl
</programlisting>
</programlisting>

<para>This feature is considered dangerous because even if all the required files are signed with the
keys being loaded, some files necessary for the system to function properly still won't be. This
Expand Down Expand Up @@ -409,7 +409,7 @@ sbvarsign --attr "${attr}" --key KEK.key --cert KEK.pem --output db.auth db db.e
timeout 0
default 01234567890abcdef1234567890abdf0-*
editor no
</programlisting>
</programlisting>

<para>The menu will not be shown by default (the menu can still be shown by
pressing and holding a key during boot). One of the entries with files with a
Expand Down
2 changes: 1 addition & 1 deletion man/org.freedesktop.LogControl1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ node /org/freedesktop/LogControl1 {
interface org.freedesktop.DBus.Introspectable { ... };
interface org.freedesktop.DBus.Properties { ... };
};
</programlisting>
</programlisting>

<!--Autogenerated cross-references for systemd.directives, do not edit-->

Expand Down
6 changes: 3 additions & 3 deletions man/org.freedesktop.home1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ node /org/freedesktop/home1 {
interface org.freedesktop.DBus.Introspectable { ... };
interface org.freedesktop.DBus.Properties { ... };
};
</programlisting>
</programlisting>

<!--Autogenerated cross-references for systemd.directives, do not edit-->

Expand Down Expand Up @@ -337,7 +337,7 @@ node /org/freedesktop/home1 {
can be used to further customize the behavior of this method via flags defined as follows:</para>
<programlisting>
#define SD_HOMED_UPDATE_OFFLINE (UINT64_C(1) &lt;&lt; 0)
</programlisting>
</programlisting>
<para>When <constant>SD_HOMED_UPDATE_OFFLINE</constant> (0x01) is set, no attempt is made to update the copies
of the user record and blob directory that are embedded into the home directory. Changes will be stored, however,
and may be propagated into the home directory the next time it is reconciled (most likely when the user next logs in).
Expand Down Expand Up @@ -495,7 +495,7 @@ node /org/freedesktop/home1/home {
interface org.freedesktop.DBus.Properties { ... };
interface org.freedesktop.DBus.ObjectManager { ... };
};
</programlisting>
</programlisting>

<!--Autogenerated cross-references for systemd.directives, do not edit-->

Expand Down
4 changes: 2 additions & 2 deletions man/org.freedesktop.hostname1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ node /org/freedesktop/hostname1 {
interface org.freedesktop.DBus.Introspectable { ... };
interface org.freedesktop.DBus.Properties { ... };
};
</programlisting>
</programlisting>

<!--Autogenerated cross-references for systemd.directives, do not edit-->

Expand Down Expand Up @@ -436,7 +436,7 @@ node /org/freedesktop/hostname1 {
<programlisting>$ gdbus introspect --system \
--dest org.freedesktop.hostname1 \
--object-path /org/freedesktop/hostname1
</programlisting>
</programlisting>
</example>
</refsect1>

Expand Down
8 changes: 4 additions & 4 deletions man/org.freedesktop.import1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ node /org/freedesktop/import1 {
interface org.freedesktop.DBus.Introspectable { ... };
interface org.freedesktop.DBus.Properties { ... };
};
</programlisting>
</programlisting>

<!--Autogenerated cross-references for systemd.directives, do not edit-->

Expand Down Expand Up @@ -362,7 +362,7 @@ node /org/freedesktop/import1/transfer/_1 {
interface org.freedesktop.DBus.Introspectable { ... };
interface org.freedesktop.DBus.Properties { ... };
};
</programlisting>
</programlisting>

<!--Autogenerated cross-references for systemd.directives, do not edit-->

Expand Down Expand Up @@ -439,7 +439,7 @@ node /org/freedesktop/import1/transfer/_1 {
<programlisting>$ gdbus introspect --system \
--dest org.freedesktop.import1 \
--object-path /org/freedesktop/import1
</programlisting>
</programlisting>
</example>

<example>
Expand All @@ -448,7 +448,7 @@ node /org/freedesktop/import1/transfer/_1 {
<programlisting>$ gdbus introspect --system \
--dest org.freedesktop.import1 \
--object-path /org/freedesktop/import1/transfer/_1
</programlisting>
</programlisting>
</example>
</refsect1>

Expand Down
4 changes: 2 additions & 2 deletions man/org.freedesktop.locale1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ node /org/freedesktop/locale1 {
interface org.freedesktop.DBus.Introspectable { ... };
interface org.freedesktop.DBus.Properties { ... };
};
</programlisting>
</programlisting>

<!--Autogenerated cross-references for systemd.directives, do not edit-->

Expand Down Expand Up @@ -175,7 +175,7 @@ node /org/freedesktop/locale1 {
$ gdbus introspect --system \
--dest org.freedesktop.locale1 \
--object-path /org/freedesktop/locale1
</programlisting>
</programlisting>
</example>
</refsect1>

Expand Down
26 changes: 13 additions & 13 deletions man/org.freedesktop.login1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ node /org/freedesktop/login1 {
interface org.freedesktop.DBus.Introspectable { ... };
interface org.freedesktop.DBus.Properties { ... };
};
</programlisting>
</programlisting>

<!--property SleepOperation is not documented!-->

Expand Down Expand Up @@ -673,7 +673,7 @@ node /org/freedesktop/login1 {
#define SD_LOGIND_SOFT_REBOOT (UINT64_C(1) &lt;&lt; 2)
#define SD_LOGIND_SOFT_REBOOT_IF_NEXTROOT_SET_UP (UINT64_C(1) &lt;&lt; 3)
#define SD_LOGIND_SKIP_INHIBITORS (UINT64_C(1) &lt;&lt; 4)
</programlisting>
</programlisting>
<para>When the <varname>flags</varname> is 0 then these methods behave just like the versions without
flags. Since systemd version 257 active inhibitors are honoured by default for privileged users too.
<constant>SD_LOGIND_ROOT_CHECK_INHIBITORS</constant> (0x01) now only applies to weak inhibitors, to
Expand Down Expand Up @@ -945,7 +945,7 @@ node /org/freedesktop/login1/seat/seat0 {
interface org.freedesktop.DBus.Introspectable { ... };
interface org.freedesktop.DBus.Properties { ... };
};
</programlisting>
</programlisting>

<!--Autogenerated cross-references for systemd.directives, do not edit-->

Expand Down Expand Up @@ -1065,7 +1065,7 @@ node /org/freedesktop/login1/user/_1000 {
interface org.freedesktop.DBus.Introspectable { ... };
interface org.freedesktop.DBus.Properties { ... };
};
</programlisting>
</programlisting>

<!--Autogenerated cross-references for systemd.directives, do not edit-->

Expand Down Expand Up @@ -1260,7 +1260,7 @@ node /org/freedesktop/login1/session/1 {
interface org.freedesktop.DBus.Introspectable { ... };
interface org.freedesktop.DBus.Properties { ... };
};
</programlisting>
</programlisting>

<!--Autogenerated cross-references for systemd.directives, do not edit-->

Expand Down Expand Up @@ -1566,25 +1566,25 @@ node /org/freedesktop/login1/session/1 {

<programlisting>$ gdbus introspect --system --dest org.freedesktop.login1 \
--object-path /org/freedesktop/login1
</programlisting>
</programlisting>

<para>or</para>

<programlisting>$ busctl introspect org.freedesktop.login1 /org/freedesktop/login1
</programlisting>
</programlisting>
</example>

<example>
<title>Introspect the default seat on the bus</title>

<programlisting>$ gdbus introspect --system --dest org.freedesktop.login1 \
--object-path /org/freedesktop/login1/seat/seat0
</programlisting>
</programlisting>

<para>or</para>

<programlisting>$ busctl introspect org.freedesktop.login1 /org/freedesktop/login1/seat/seat0
</programlisting>
</programlisting>

<para>Seat <literal>seat0</literal> is the default seat, so it'll be present unless local configuration
is made to reassign all devices to a different seat. The list of seats and users can be acquired with
Expand All @@ -1596,25 +1596,25 @@ node /org/freedesktop/login1/session/1 {

<programlisting>$ gdbus introspect --system --dest org.freedesktop.login1 \
--object-path /org/freedesktop/login1/user/_1000
</programlisting>
</programlisting>

<para>or</para>

<programlisting>$ busctl introspect org.freedesktop.login1 /org/freedesktop/login1/user/_1000
</programlisting>
</programlisting>
</example>

<example>
<title>Introspect <interfacename>org.freedesktop.login1.Session</interfacename> on the bus</title>

<programlisting>$ gdbus introspect --system --dest org.freedesktop.login1 \
--object-path /org/freedesktop/login1/session/45
</programlisting>
</programlisting>

<para>or</para>

<programlisting>$ busctl introspect org.freedesktop.login1 /org/freedesktop/login1/session/45
</programlisting>
</programlisting>
</example>
</refsect1>

Expand Down
8 changes: 4 additions & 4 deletions man/org.freedesktop.machine1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ node /org/freedesktop/machine1 {
interface org.freedesktop.DBus.Introspectable { ... };
interface org.freedesktop.DBus.Properties { ... };
};
</programlisting>
</programlisting>

<!--method UnregisterMachine is not documented!-->

Expand Down Expand Up @@ -531,7 +531,7 @@ node /org/freedesktop/machine1/machine/rawhide {
interface org.freedesktop.DBus.Introspectable { ... };
interface org.freedesktop.DBus.Properties { ... };
};
</programlisting>
</programlisting>

<!--method GetUIDShift is not documented!-->

Expand Down Expand Up @@ -687,7 +687,7 @@ node /org/freedesktop/machine1/machine/rawhide {
$ gdbus introspect --system \
--dest org.freedesktop.machine1 \
--object-path /org/freedesktop/machine1
</programlisting>
</programlisting>
</example>

<example>
Expand All @@ -697,7 +697,7 @@ $ gdbus introspect --system \
$ gdbus introspect --system \
--dest org.freedesktop.machine1 \
--object-path /org/freedesktop/machine1/machine/rawhide
</programlisting>
</programlisting>
</example>
</refsect1>

Expand Down
16 changes: 8 additions & 8 deletions man/org.freedesktop.network1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ node /org/freedesktop/network1 {
interface org.freedesktop.DBus.Introspectable { ... };
interface org.freedesktop.DBus.Properties { ... };
};
</programlisting>
</programlisting>

<!--method ListLinks is not documented!-->

Expand Down Expand Up @@ -270,7 +270,7 @@ node /org/freedesktop/network1/link/_1 {
interface org.freedesktop.DBus.Introspectable { ... };
interface org.freedesktop.DBus.Properties { ... };
};
</programlisting>
</programlisting>

<!--method SetNTP is not documented!-->

Expand Down Expand Up @@ -407,7 +407,7 @@ node /org/freedesktop/network1/network/_1 {
interface org.freedesktop.DBus.Introspectable { ... };
interface org.freedesktop.DBus.Properties { ... };
};
</programlisting>
</programlisting>

<!--property Description is not documented!-->

Expand Down Expand Up @@ -464,7 +464,7 @@ node /org/freedesktop/network1/link/_1 {
interface org.freedesktop.DBus.Properties { ... };
interface org.freedesktop.network1.Link { ... };
};
</programlisting>
</programlisting>

<!--property Leases is not documented!-->

Expand Down Expand Up @@ -501,7 +501,7 @@ node /org/freedesktop/network1/link/_1 {
interface org.freedesktop.DBus.Properties { ... };
interface org.freedesktop.network1.Link { ... };
};
</programlisting>
</programlisting>

<!--property State is not documented!-->

Expand Down Expand Up @@ -538,7 +538,7 @@ node /org/freedesktop/network1/link/_1 {
interface org.freedesktop.DBus.Properties { ... };
interface org.freedesktop.network1.Link { ... };
};
</programlisting>
</programlisting>

<!--property State is not documented!-->

Expand Down Expand Up @@ -571,7 +571,7 @@ node /org/freedesktop/network1/link/_1 {
$ gdbus introspect --system \
--dest org.freedesktop.network1 \
--object-path /org/freedesktop/network1
</programlisting>
</programlisting>
</example>

<example>
Expand All @@ -581,7 +581,7 @@ $ gdbus introspect --system \
$ gdbus introspect --system \
--dest org.freedesktop.network1 \
--object-path /org/freedesktop/network1/link/_11
</programlisting>
</programlisting>
</example>
</refsect1>

Expand Down
2 changes: 1 addition & 1 deletion man/org.freedesktop.oom1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ node /org/freedesktop/oom1 {
interface org.freedesktop.DBus.Introspectable { ... };
interface org.freedesktop.DBus.Properties { ... };
};
</programlisting>
</programlisting>

<!--method DumpByFileDescriptor is not documented!-->

Expand Down
6 changes: 3 additions & 3 deletions man/org.freedesktop.portable1.xml
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ node /org/freedesktop/portable1 {
interface org.freedesktop.DBus.Introspectable { ... };
interface org.freedesktop.DBus.Properties { ... };
};
</programlisting>
</programlisting>

<!--Autogenerated cross-references for systemd.directives, do not edit-->

Expand Down Expand Up @@ -329,7 +329,7 @@ node /org/freedesktop/portable1 {
#define SD_SYSTEMD_PORTABLE_RUNTIME (UINT64_C(1) &lt;&lt; 0)
#define SD_SYSTEMD_PORTABLE_FORCE_ATTACH (UINT64_C(1) &lt;&lt; 1)
#define SD_SYSTEMD_PORTABLE_FORCE_EXTENSION (UINT64_C(1) &lt;&lt; 2)
</programlisting>
</programlisting>
</refsect2>

<refsect2>
Expand Down Expand Up @@ -428,7 +428,7 @@ node /org/freedesktop/portable1 {
interface org.freedesktop.DBus.Introspectable { ... };
interface org.freedesktop.DBus.Properties { ... };
};
</programlisting>
</programlisting>

<!--method GetOSRelease is not documented!-->

Expand Down
Loading

0 comments on commit fe45f8d

Please sign in to comment.