diff options
author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2023-11-06 12:43:40 +0100 |
---|---|---|
committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2023-11-06 20:16:34 +0100 |
commit | c8cd6d7bab8264fa0ebf08a5b170758ce13dac92 (patch) | |
tree | 871f07a054cab43cafa22964036420284d93bccc /man/systemd-id128.xml | |
parent | Merge pull request #29873 from yuwata/network-revert-hop-limit (diff) | |
download | systemd-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/systemd-id128.xml')
-rw-r--r-- | man/systemd-id128.xml | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/man/systemd-id128.xml b/man/systemd-id128.xml index 32c5af9671..d9378b69df 100644 --- a/man/systemd-id128.xml +++ b/man/systemd-id128.xml @@ -137,8 +137,8 @@ <term><option>--uuid</option></term> <listitem><para>Generate output as a UUID formatted in the "canonical representation", with five - groups of digits separated by hyphens. See the - <ulink url="https://en.wikipedia.org/wiki/Universally_unique_identifier#Format">wikipedia</ulink> + groups of digits separated by hyphens. See the Wikipedia entry for + <ulink url="https://en.wikipedia.org/wiki/Universally_unique_identifier#Format">Universally Unique Identifiers</ulink> for more discussion.</para> <xi:include href="version-info.xml" xpointer="v244"/></listitem> |