diff options
author | Lubomir Rintel <lkundrak@v3.sk> | 2022-11-13 22:51:00 +0100 |
---|---|---|
committer | Lubomir Rintel <lkundrak@v3.sk> | 2022-11-13 23:36:37 +0100 |
commit | 03813a530a28c3f51a3a446e1bf9f4236be9869d (patch) | |
tree | 874498877d2784ac8120ef95a05ec5704c796190 | |
parent | 4c6b00d696e17e4b8e3ad90414caf3a1d3d739a8 (diff) |
tools/check-docs: more checks for missing includeslr/gtk-doc
We get this wrong *very* often.
-rwxr-xr-x | tools/check-docs.sh | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/tools/check-docs.sh b/tools/check-docs.sh index c2e6761d0d..ecf42d0387 100755 --- a/tools/check-docs.sh +++ b/tools/check-docs.sh @@ -69,12 +69,35 @@ F2="$(grep -l "$(sed -n 's/^[\t ]*\(.*_get_type\);/\1/p' "$SOURCEDIR/src/libnm-c F2_EXTRA=" annotation-glossary api-index-full +nm-conn-utils nm-dbus-interface nm-errors +nm-ethtool-utils nm-keyfile nm-utils nm-version +nm-version-macros +nm-vpn-dbus-interface " if ! same_lines "$F1"$'\n'"$F1_EXTRA" "$F2"$'\n'"$F2_EXTRA"; then die "*** Error: libnm classes not included in docs/libnm/libnm-docs.xml ***" fi + +F1="$(sed -n 's/^#include "\(nm-.*\).h"$/xml\/\1.xml/p' "$SOURCEDIR/src/libnm-client-public/NetworkManager.h")" +F1_EXTRA=" +xml/annotation-glossary.xml +xml/api-index-full.xml +xml/nm-setting-ovs-external-ids.xml +xml/nm-version-macros.xml +xml/nm-secret-agent-old.xml +xml/nm-vpn-plugin-old.xml +" +F2="$(sed -n 's/.*<xi:include href="\(xml\/.*.xml\)".*/\1/p' "$SOURCEDIR/docs/libnm/libnm-docs.xml")" +F2_EXTRA=" +xml/nm-autoptr.xml +xml/nm-core-enum-types.xml +xml/nm-enum-types.xml +" +if ! same_lines "$F1"$'\n'"$F1_EXTRA" "$F2"$'\n'"$F2_EXTRA"; then + die "*** Error: documentation from public headers not included in docs/libnm/libnm-docs.xml ***" +fi |