summaryrefslogtreecommitdiffstats
path: root/man/sd_bus_set_description.xml
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2023-11-06 12:43:40 +0100
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2023-11-06 20:16:34 +0100
commitc8cd6d7bab8264fa0ebf08a5b170758ce13dac92 (patch)
tree871f07a054cab43cafa22964036420284d93bccc /man/sd_bus_set_description.xml
parentMerge pull request #29873 from yuwata/network-revert-hop-limit (diff)
downloadsystemd-c8cd6d7bab8264fa0ebf08a5b170758ce13dac92.tar.xz
systemd-c8cd6d7bab8264fa0ebf08a5b170758ce13dac92.zip
man: use meaningful titles for <ulink>s
As pointed out in https://github.com/systemd/systemd/issues/29814, we need to use phrases are are meaningful on their own, because the man page formatter creates a list at the bottom. With <ulink>see docs</ulink>, we end up with: NOTES: 1. see docs https://some.url/page 2. see docs https://some.url/page2 which is not very useful :( Also, the text inside the tag should not include punctuation. Python helper: from xml_helper import xml_parse for p in glob.glob('../man/*.xml'): t = xml_parse(p) ulinks = t.iterfind('.//ulink') for ulink in ulinks: if ulink.text is None: continue text = ' '.join(ulink.text.split()) print(f'{p}: {text}')
Diffstat (limited to 'man/sd_bus_set_description.xml')
-rw-r--r--man/sd_bus_set_description.xml2
1 files changed, 1 insertions, 1 deletions
diff --git a/man/sd_bus_set_description.xml b/man/sd_bus_set_description.xml
index 0cc0ee77e9..0b49ba3a3b 100644
--- a/man/sd_bus_set_description.xml
+++ b/man/sd_bus_set_description.xml
@@ -121,7 +121,7 @@
i.e. lack of authentication, of the bus peer. This function must be called before the bus is
started. See the
<ulink url="view-source:https://dbus.freedesktop.org/doc/dbus-specification.html#auth-mechanisms">
- Authentication Mechanisms</ulink> section of the D-Bus specification for details.</para>
+ D-Bus Authentication Mechanisms</ulink> section of the D-Bus specification for details.</para>
<para><function>sd_bus_is_anonymous()</function> returns true if the bus connection allows
anonymous authentication (in the sense described in previous paragraph).</para>