Commit 9a54f8a1 authored by Keith Packard's avatar Keith Packard

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.
parent c833409f
......@@ -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
......
#!/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 '[<>]'
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment