summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBehdad Esfahbod <behdad@behdad.org>2008-09-18 15:33:10 -0400
committerBehdad Esfahbod <behdad@behdad.org>2008-09-18 15:33:10 -0400
commitd02fb0fd2044652255da0922f70199e7a84a31c1 (patch)
treed051a02ec3c945b8d61d5a13af2f103170cee07f
parentc6a7971a1e83d80050c4e2cfb42401a8d3c1b321 (diff)
[doc/public/check-doc-coverage.sh] Make doc building needed for the test faster
We used to do a full doc build to just to run the coverage test. That's way too slow to expect people to run regularly. Instead now we just do the source code scanning part of the doc build system that is just enough to know if all symbols are documented. A full doc build can be done as always by invoking "make doc", and indeed will be called as part of "make dist" or "make distcheck".
-rw-r--r--doc/public/Makefile.am6
-rwxr-xr-xdoc/public/check-doc-coverage.sh3
2 files changed, 7 insertions, 2 deletions
diff --git a/doc/public/Makefile.am b/doc/public/Makefile.am
index 464cf47b6..b4db8b765 100644
--- a/doc/public/Makefile.am
+++ b/doc/public/Makefile.am
@@ -50,11 +50,13 @@ include $(top_srcdir)/build/Makefile.am.gtk-doc
dist-hook: doc
+# This line really belongs in gtk-doc.mk
+$(REPORT_FILES): sgml-build.stamp
+
if ENABLE_GTK_DOC
-check: doc
TESTS += check-doc-coverage.sh
endif
TESTS += check-doc-syntax.sh
EXTRA_DIST += check-doc-coverage.sh check-doc-syntax.sh
-TESTS_ENVIRONMENT = srcdir="$(srcdir)" top_srcdir="$(top_srcdir)" MAKE="$(MAKE) $(AM_MAKEFLAGS)"
+TESTS_ENVIRONMENT = srcdir="$(srcdir)" top_srcdir="$(top_srcdir)" MAKE="$(MAKE) $(AM_MAKEFLAGS)" DOC_MODULE="$(DOC_MODULE)" REPORT_FILES="$(REPORT_FILES)"
diff --git a/doc/public/check-doc-coverage.sh b/doc/public/check-doc-coverage.sh
index 26212dc01..5257c7aca 100755
--- a/doc/public/check-doc-coverage.sh
+++ b/doc/public/check-doc-coverage.sh
@@ -11,6 +11,9 @@ if test -z "$DOC_MODULE"; then
fi
fi
+if test -n "$REPORT_FILES"; then
+ $MAKE $REPORT_FILES || exit 1
+fi
test -z "$srcdir" && srcdir=.
stat=0