GNOME Bugzilla – Bug 552822
Add rules to create $(REPORT_FILES)
Last modified: 2008-10-03 13:11:36 UTC
In gtk-doc.mk, add: $(REPORT_FILES): sgml-build.stamp I use REPORT_FILES to check that cairo is 100% documented. It's much faster to just build those instead of doing a full doc build.
How do you use it practically?
$ cat check-doc-coverage.sh #!/bin/sh LANG=C if test -z "$DOC_MODULE"; then # extract from Makefile eval `grep '^DOC_MODULE' Makefile | sed 's/ //g'` if test -z "$DOC_MODULE"; then echo Failed extracting DOC_MODULE from Makefile 1>&2 echo Try setting DOC_MODULE env var manually 1>&2 exit 1 fi fi if test -n "$REPORT_FILES"; then $MAKE $REPORT_FILES || exit 1 fi test -z "$srcdir" && srcdir=. stat=0 if test -f "$DOC_MODULE-undeclared.txt"; then undeclared=`cat "$DOC_MODULE-undeclared.txt"` if test -n "$undeclared"; then echo Undeclared documentation symbols: 1>&2 cat "$DOC_MODULE-undeclared.txt" 1>&2 stat=1 fi fi if test -f "$DOC_MODULE-unused.txt"; then unused=`cat "$DOC_MODULE-unused.txt"` if test -n "$unused"; then echo Unused documentated symbols: 1>&2 cat "$DOC_MODULE-unused.txt" 1>&2 stat=1 fi fi if test -f "$DOC_MODULE-undocumented.txt"; then if grep '^0 symbols incomplete' "$DOC_MODULE-undocumented.txt" >/dev/null && grep '^0 not documented' "$DOC_MODULE-undocumented.txt" >/dev/null; then : else echo Incomplete or undocumented symbols: 1>&2 cat "$DOC_MODULE-undocumented.txt" 1>&2 stat=1 fi fi exit $stat
2008-10-03 Stefan Kost <ensonic@users.sf.net> patch by: Behdad Esfahbod <behdad@gnome.org> * gtk-doc.make: * gtk-doc.notmpl.make: * tests/gtk-doc.make: * tests/gtk-doc.notmpl.make: Add rules to create $(REPORT_FILES). Fixes #552822.