mirror of
https://gitlab.freedesktop.org/cairo/cairo.git
synced 2025-12-20 22:10:13 +01:00
d02fb0fd20
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".
48 lines
1.1 KiB
Bash
Executable file
48 lines
1.1 KiB
Bash
Executable file
#!/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
|