NetworkManager/man
Thomas Haller 42aa225185
docs: better handle description tags in generate-docs-nm-settings-docs-merge.py
When we generate the manual page for nm-settings-nmcli, we run:

   "/usr/bin/python" \
        ./tools/generate-docs-nm-settings-docs-merge.py \
        --only-from-first \
        man/nm-settings-docs-nmcli.xml \
        src/nmcli/gen-metadata-nm-settings-nmcli.xml \
        src/libnm-client-impl/nm-property-infos-nmcli.xml \
        src/libnm-client-impl/nm-settings-docs-gir.xml

If "gen-metadata-nm-settings-nmcli.xml" contains either a <description>
or a <description-docbook>, then we must not continue searching the
other XML documents. The user provided an explicit override, and
fallback (search further) is wrong. Previously, we might take
<description> from the first file, and <description-docbook> from the
second file. As "man/nm-settings-nmcli.xsl" prefers
<description-docbook>, it takes the wrong text. Instead, as we search
the files during merge, we must prefer the first one.

Note that the change doesn't really matter anymore, because each XML
now must also contain both <description> and <description-docbook>.
There is an assertion for that.

Also, stop generating <deprecated-docbook>. First, it lacked the
important "since=" attribute and was necessary. Also, it's redundant and
does not contain anything interesting. So far, we don't need special
formatting for the deprecated message, and we likely never will.

Also, stop accepting or generating the "description=" attribute. This
should always be an XML element now.
2023-05-19 12:52:00 +02:00
..
common.ent.in build: allow configuring default for wifi.backend setting 2022-01-04 06:41:37 +01:00
meson.build nmcli: rename "generate-docs-nm-settings-nmcli" to "gen-metadata-nm-settings-nmcli" 2022-10-31 09:11:30 +01:00
NetworkManager-dispatcher.xml man: NetworkManager-dispatcher: document reapply action 2023-02-08 20:51:07 +01:00
NetworkManager-wait-online.service.xml doc: fix documenting "carrier-wait-timeout" in NetworkManager-wait-online manual 2023-02-24 11:50:40 +01:00
NetworkManager.conf.xml man: update documentation about global DNS configuration 2023-03-03 14:06:24 +01:00
NetworkManager.xml man: update "--print-config" text in man NetworkManager 2022-09-08 16:19:11 +02:00
nm-cloud-setup.xml cloud-setup: use suppress_prefixlength rule to honor non-default-routes in the main table 2021-09-16 17:30:25 +02:00
nm-initrd-generator.xml man/nm-initrd-generator: add missing command line options 2022-07-14 21:32:48 +02:00
nm-online.xml man: add NetworkManager-wait-online.service.8 manual 2022-03-02 16:09:16 +01:00
nm-openvswitch.xml man: update nm-openswitch example 2019-07-09 12:05:32 +02:00
nm-settings-dbus.xsl man/nm-settings-dbus: include deprecation description, if present 2022-09-07 10:55:31 +02:00
nm-settings-ifcfg-rh.xsl nm-settings-ifcfg-rh: fix typo 2022-05-26 11:41:31 +02:00
nm-settings-keyfile.xsl docs: unify "nm-property-infos-*.xml" and "nm-settings-docs-*.xml" (root element) 2020-06-11 10:53:50 +02:00
nm-settings-nmcli.xsl docs: better handle description tags in generate-docs-nm-settings-docs-merge.py 2023-05-19 12:52:00 +02:00
nmcli-examples.xml nmcli/devices: add "checkpoint" command 2022-06-15 12:26:08 +02:00
nmcli.xml man/nmcli: document variables affecting fancy output 2022-10-11 16:34:49 +02:00
nmtui.1.in man: update version number and dates in manual pages 2016-03-09 10:11:27 +01:00
nmtui.xml man: turn the manual page cross-references into links 2016-06-21 18:40:13 +02:00