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/resolvectl.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/resolvectl.xml')
-rw-r--r-- | man/resolvectl.xml | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/man/resolvectl.xml b/man/resolvectl.xml index 549dbbd2b7..4498732656 100644 --- a/man/resolvectl.xml +++ b/man/resolvectl.xml @@ -77,17 +77,17 @@ [[<replaceable>NAME</replaceable>] <replaceable>TYPE</replaceable>] <replaceable>DOMAIN</replaceable></term> - <listitem><para>Resolve <ulink url="https://tools.ietf.org/html/rfc6763">DNS-SD</ulink> and <ulink - url="https://tools.ietf.org/html/rfc2782">SRV</ulink> services, depending on the specified list of - parameters. If three parameters are passed the first is assumed to be the DNS-SD service name, the - second the <constant class='dns'>SRV</constant> service type, and the third the domain to search in. - In this case a full DNS-SD style <constant class='dns'>SRV</constant> and <constant - class='dns'>TXT</constant> lookup is executed. If only two parameters are specified, the first is - assumed to be the <constant class='dns'>SRV</constant> service type, and the second the domain to look - in. In this case no <constant class='dns'>TXT</constant> resource record is requested. Finally, if - only one parameter is specified, it is assumed to be a domain name, that is already prefixed with an - <constant class='dns'>SRV</constant> type, and an <constant class='dns'>SRV</constant> lookup is done - (no <constant class='dns'>TXT</constant>).</para> + <listitem><para>Resolve <ulink url="https://tools.ietf.org/html/rfc6763">RFC 6763 DNS-SD</ulink> and + <ulink url="https://tools.ietf.org/html/rfc2782">RFC 2782 SRV</ulink> services, depending on the + specified list of parameters. If three parameters are passed the first is assumed to be the DNS-SD + service name, the second the <constant class='dns'>SRV</constant> service type, and the third the + domain to search in. In this case a full DNS-SD style <constant class='dns'>SRV</constant> and + <constant class='dns'>TXT</constant> lookup is executed. If only two parameters are specified, the + first is assumed to be the <constant class='dns'>SRV</constant> service type, and the second the + domain to look in. In this case no <constant class='dns'>TXT</constant> resource record is requested. + Finally, if only one parameter is specified, it is assumed to be a domain name, that is already + prefixed with an <constant class='dns'>SRV</constant> type, and an <constant + class='dns'>SRV</constant> lookup is done (no <constant class='dns'>TXT</constant>).</para> <xi:include href="version-info.xml" xpointer="v239"/></listitem> </varlistentry> |