From 8b73fbca799114ed579acb73ce0bbcdf45b1f171 Mon Sep 17 00:00:00 2001 From: "Fabio M. Di Nitto" Date: Tue, 30 Apr 2019 05:42:16 +0200 Subject: [PATCH] [tests] add man page check to verify doxy header order and definitions Signed-off-by: Fabio M. Di Nitto --- man/api-to-man-page-coverage | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/man/api-to-man-page-coverage b/man/api-to-man-page-coverage index 92e60a5..b9dc18f 100755 --- a/man/api-to-man-page-coverage +++ b/man/api-to-man-page-coverage @@ -14,6 +14,21 @@ target="$2" headerapicalls="$(grep ${target}_ "$srcdir"/lib${target}/lib${target}.h | grep -v "^ \*" | grep -v ^struct | grep -v "^[[:space:]]" | grep -v typedef | sed -e 's/(.*//g' -e 's/^const //g' -e 's/\*//g' | awk '{print $2}')" manpages="$(grep ${target}_ "$srcdir"/man/Makefile.am |grep -v man3 |grep -v xml | sed -e 's/\.3.*//g')" +echo "Checking for header format errors" + +for i in $headerapicalls; do + echo "Checking $i" + header="$(grep " \* ${i}$" "$srcdir"/lib${target}/lib${target}.h -A2)" + brief="$(echo "$header" | tail -n 1 |grep "@brief")" + if [ -z "$brief" ]; then + echo "Error found in $i doxy header section" + echo "$header" + echo "" + echo "$brief" + exit 1 + fi +done + echo "Checking for symbols in header file NOT distributed as manpages" for i in $headerapicalls; do -- 2.39.5