Merge branch '1828-util-check-categories-sh-needs-updating-for-doc-arm-logging-categories-rst' into 'master'

Resolve "util/check-categories.sh needs updating for doc/arm/logging-categories.rst"

Closes #1828

See merge request isc-projects/bind9!3509

.gitlab-ci.yml

@@ -394,8 +394,8 @@ misc:
     - perl -w util/update_copyrights < util/copyrights
     - if test "$(git status --porcelain | grep -Ev '\?\?' | wc -l)" -gt "0"; then git status --short; exit 1; fi
     - xmllint --noout --nonet `git ls-files '*.xml' '*.docbook'`
-    - xmllint --noout --nonet --html `git ls-files '*.html'`
     - sh util/check-win32util-configure
+    - sh util/check-categories.sh
   needs: []
   artifacts:
     paths:

doc/arm/logging-categories.rst

@@ -145,6 +145,10 @@
 |                            | files, rewritten responses, and at the highest     |
 |                            | ``debug`` levels, mere rewriting attempts.         |
 +----------------------------+----------------------------------------------------+
+| ``rpz-passthru``           | Information about RPZ PASSTHRU policy activity.    |
+|                            | This category allows the whitelist policy activity |
+|                            | to be logged into a dedicated channel.             |
++----------------------------+----------------------------------------------------+
 | ``security``               | Approval and denial of requests.                   |
 +----------------------------+----------------------------------------------------+
 | ``serve-stale``            | Whether or not a stale answer is used following a  |

util/check-categories.sh

@@ -7,12 +7,21 @@
 # See the COPYRIGHT file distributed with this work for additional
 # information regarding copyright ownership.
 
-list1=`grep LOGCATEGORY lib/*/include/*/*.h bin/named/include/named/*.h |
-grep "#define.*(&" |
-sed -e 's/.*LOGCATEGORY_\([A-Z_]*\).*/\1/' -e 's/^RRL$/rate-limit/' |
-tr '[A-Z]' '[a-z]' |
-tr _ - | sed 's/^tat$/trust-anchor-telemetry/' | sort -u`
-list2=`sed -n 's;.*<para><command>\(.*\)</command></para>;\1;p' doc/arm/logging-categories.xml | tr '[A-Z]' '[a-z]' | sort -u`
+list1=$(
+	grep LOGCATEGORY lib/*/include/*/*.h bin/named/include/named/*.h |
+	grep "#define.*(&" |
+	sed -e 's/.*LOGCATEGORY_\([A-Z_]*\).*/\1/' -e 's/^RRL$/rate-limit/' |
+	tr '[A-Z]' '[a-z]' |
+	tr _ - |
+	sed 's/^tat$/trust-anchor-telemetry/' |
+	sort -u
+)
+list2=$(
+	awk '$1 == "|" && $3 == "|" && $NF == "|" && $2 ~ /^``.*``$/ { print $2 }' doc/arm/logging-categories.rst |
+	sed 's/``//g' |
+	sort -u
+)
+status=0
 for i in $list1
 do
 	ok=no
@@ -26,6 +35,7 @@ do
 	if test $ok = no
 	then
 		echo "$i missing from documentation."
+		status=1
 	fi
 done
 for i in $list2
@@ -41,5 +51,7 @@ do
 	if test $ok = no
 	then
 		echo "$i not in code."
+		status=1
 	fi
 done
+exit $status