From: Keith Packard <keithp@koto.keithp.com>
Date: Sun, 4 Nov 2007 05:01:33 +0000 (-0700)
Subject: Verify documentation covers exposed symbols.
X-Git-Tag: 2.4.92~26
X-Git-Url: https://git.wh0rd.org/?a=commitdiff_plain;h=9a54f8a1945e614e07446412a2df534fbc1f77cb;p=fontconfig.git

Verify documentation covers exposed symbols.

Add check-missing-doc script to make sure the documentation matches the
complete list of symbols exported from the header files before release.
---

diff --git a/doc/Makefile.am b/doc/Makefile.am
index bf1ab99..7b40eb4 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -86,7 +86,11 @@ docdir=@DOCDIR@
 DOC_FILES=$(TXT) $(PDF) $(HTML_FILES)
 LOCAL_DOCS=$(man3_MANS) $(man5_MANS) $(DOC_FILES) $(HTML_DIR)/*
 
-EXTRA_DIST=$(LOCAL_DOCS) $(SGML) $(DOC_FUNCS_FNCS) func.sgml confdir.sgml.in
+check_SCRIPTS=check-missing-doc
+TESTS_ENVIRONMENT=top_srcdir=${top_srcdir} sh
+TESTS=check-missing-doc
+
+EXTRA_DIST=$(LOCAL_DOCS) $(SGML) $(DOC_FUNCS_FNCS) $(check_SCRIPTS) func.sgml confdir.sgml.in
 
 SUFFIXES=.fncs .sgml .txt .html
 
diff --git a/doc/check-missing-doc b/doc/check-missing-doc
new file mode 100644
index 0000000..13d1eb9
--- /dev/null
+++ b/doc/check-missing-doc
@@ -0,0 +1,23 @@
+#!/bin/sh
+header=fontconfig-header
+doc=fontconfig-doc
+#trap "rm $header $doc"  0 1 15
+top_srcdir=${top_srcdir-".."}
+(
+cat $top_srcdir/fontconfig/*.h  | grep '^Fc' | 
+ grep -v FcPublic | sed 's/[^a-zA-Z0-9].*//';
+ cat $top_srcdir/fontconfig/*.h  | 
+ sed -n 's/#define \(Fc[a-zA-Z]*\)(.*$/\1/p') |
+ sort -u > $header
+
+grep '@FUNC@' $top_srcdir/doc/*.fncs |
+awk '{print $2}' |
+sort -u > $doc
+
+if cmp $doc $header > /dev/null; then
+	exit 0
+fi
+
+echo \
+'Library Export							Documentation'
+diff -y $header $doc | grep '[<>]'