NetworkManager/tools
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
..
nm-in-container nm-in-container: run with "--no-hosts" to have a plain /etc/hosts in the container 2023-05-15 11:02:10 +02:00
check-compare-generated.sh build: pass both filenames to "tools/check-compare-generated.sh" script 2022-10-31 09:11:30 +01:00
check-config-options.sh all: move "src/" directory to "src/core/" 2021-02-04 09:45:55 +01:00
check-docs.sh all: avoid "==" bashism in scripts 2023-05-18 09:16:41 +02:00
check-exports.sh tools/check-exports.sh: use ${NM} when available 2015-09-24 16:28:15 +02:00
check-gitlab-ci.sh tools: improve detection of "ci-fairy" command in "tools/check-gitlab-ci.sh" 2020-12-11 16:08:47 +01:00
check-nm-autoptr.sh build: add test for checking consistency of "nm-autoptr.h" 2023-02-28 16:33:07 +01:00
check-tree.sh build: move "clients/common/" to "src/libnmc-{base,setting}/" 2021-03-02 08:38:25 +01:00
check-vapi.sh vapi: add test for consistency of "vapi/NM-1.0.metadata" 2023-02-28 13:05:47 +01:00
create-exports-NetworkManager.sh build: fix pretty() sed invocation portability in .ver script 2023-03-07 08:02:22 +01:00
debug-helper.py all: reformat python files with python black 2020-06-15 16:40:38 +02:00
enums-to-docbook.pl all: update deprecated SPDX license identifiers 2021-01-05 09:46:21 +01:00
generate-docs-nm-property-infos.py docs: better handle description tags in generate-docs-nm-settings-docs-merge.py 2023-05-19 12:52:00 +02:00
generate-docs-nm-settings-docs-gir.py docs: better handle description tags in generate-docs-nm-settings-docs-merge.py 2023-05-19 12:52:00 +02:00
generate-docs-nm-settings-docs-merge.py docs: better handle description tags in generate-docs-nm-settings-docs-merge.py 2023-05-19 12:52:00 +02:00
generate-docs-settings-docs.py doc: preserve paraghraphs in nmcli man pages 2022-07-15 17:25:15 +02:00
meson-post-install.sh build/meson: force overwriting files in "meson-post-install.sh" 2022-08-08 11:54:26 +02:00
run-nm-test.sh tests: propagate 77 exit code from "tools/run-nm-test.sh" 2022-02-19 13:43:14 +01:00
test-build.sh core: rework IP configuration in NetworkManager using layer 3 configuration 2021-11-18 16:21:29 +01:00
test-cloud-meta-mock.py test/cloud-meta-mock: mock GCP metadata API 2023-05-12 12:42:55 +02:00
test-networkmanager-service.py test/nm-service: short circuit activation if AC activation delay is zero 2023-03-21 21:56:17 +01:00
test-sudo-wrapper.sh nmtst: add nmtst_reexec_sudo() function 2014-06-05 18:12:57 +02:00