]> git.ipfire.org Git - thirdparty/systemd.git/commit - man/udev.xml
man: use meaningful titles for <ulink>s
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Mon, 6 Nov 2023 11:43:40 +0000 (12:43 +0100)
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Mon, 6 Nov 2023 19:16:34 +0000 (20:16 +0100)
commitc8cd6d7bab8264fa0ebf08a5b170758ce13dac92
tree871f07a054cab43cafa22964036420284d93bccc
parent69c37b26a4743261d1bf0639bb03fa85ee7a5c38
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}')
12 files changed:
man/crypttab.xml
man/resolvectl.xml
man/sd-id128.xml
man/sd_bus_error.xml
man/sd_bus_message_append_array.xml
man/sd_bus_set_description.xml
man/systemd-id128.xml
man/systemd-sleep.conf.xml
man/systemd-system.conf.xml
man/systemd.exec.xml
man/systemd.netdev.xml
man/udev.xml