vte r2122 - in trunk: . doc/reference

[behdad svn gnome org]

Author: behdad
Date: Wed Oct 15 16:48:26 2008
New Revision: 2122
URL: http://svn.gnome.org/viewvc/vte?rev=2122&view=rev

Log:
2008-10-15  Behdad Esfahbod  <behdad gnome org>

        * doc/reference/Makefile.am:
        * doc/reference/check-doc-coverage.sh:
        * doc/reference/check.docs:
        Update doc coverage test from cairo.



Added:
   trunk/doc/reference/check-doc-coverage.sh   (contents, props changed)
Removed:
   trunk/doc/reference/check.docs
Modified:
   trunk/ChangeLog
   trunk/doc/reference/Makefile.am

Modified: trunk/doc/reference/Makefile.am
==============================================================================
--- trunk/doc/reference/Makefile.am	(original)
+++ trunk/doc/reference/Makefile.am	Wed Oct 15 16:48:26 2008
@@ -65,6 +65,11 @@
 
 include $(top_srcdir)/gtk-doc.make
 
-EXTRA_DIST += check.docs
+# This line really belongs in gtk-doc.mk
+$(REPORT_FILES): sgml-build.stamp
 
-TESTS = check.docs
+if ENABLE_GTK_DOC
+TESTS = check-doc-coverage.sh
+endif
+
+EXTRA_DIST += check-doc-coverage.sh

Added: trunk/doc/reference/check-doc-coverage.sh
==============================================================================
--- (empty file)
+++ trunk/doc/reference/check-doc-coverage.sh	Wed Oct 15 16:48:26 2008
@@ -0,0 +1,48 @@
+#!/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 >&2
+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 >&2
+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 >&2
+
+exit $stat