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.netdev.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.netdev.xml')
-rw-r--r-- | man/systemd.netdev.xml | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/man/systemd.netdev.xml b/man/systemd.netdev.xml index 2d3e575a8b..9cad358f1e 100644 --- a/man/systemd.netdev.xml +++ b/man/systemd.netdev.xml @@ -712,11 +712,11 @@ <varlistentry> <term><varname>ReduceARPProxy=</varname></term> <listitem> - <para>Takes a boolean. When true, bridge-connected VXLAN tunnel - endpoint answers ARP requests from the local bridge on behalf - of remote Distributed Overlay Virtual Ethernet + <para>Takes a boolean. When true, bridge-connected VXLAN tunnel endpoint answers ARP requests from + the local bridge on behalf of remote <ulink url="https://en.wikipedia.org/wiki/Distributed_Overlay_Virtual_Ethernet"> - (DOVE)</ulink> clients. Defaults to false.</para> + Distributed Overlay Virtual Ethernet (DOVE)</ulink> + clients. Defaults to false.</para> <xi:include href="version-info.xml" xpointer="v233"/> </listitem> |