From: Lennart Poettering <lennart@poettering.net>
Date: Thu, 7 Nov 2013 16:26:01 +0000 (+0100)
Subject: build-sys: add a make target to look for undocumented symbols
X-Git-Tag: v209~1546
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=commitdiff_plain;h=a27e222b58824c08fa0da18106cf28a02b6c5e23;ds=sidebyside

build-sys: add a make target to look for undocumented symbols

With super-pretty output!
---

diff --git a/Makefile.am b/Makefile.am
index 5c3cbc187..86baae0e7 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -4572,4 +4572,15 @@ install-tree: all
 # Let's run all tests of the test suite, but under valgrind. Let's
 # exclude the one perl script we have in there
 valgrind-tests: $(TESTS)
-	for f in $(TESTS) ; do [ "$$f" == "$${f/.pl/}" ] && libtool --mode=execute valgrind --leak-check=full --error-exitcode=55 $(builddir)/$$f ; done
+	for f in $(TESTS) ; do \
+		[ "$$f" == "$${f/.pl/}" ] && libtool --mode=execute valgrind --leak-check=full --error-exitcode=55 $(builddir)/$$f ; \
+	done
+
+check-api-docs: $(lib_LTLIBRARIES)
+	for symbol in `for f in $(lib_LTLIBRARIES) ; do nm -g --defined-only $(builddir)/.libs/"$${f/.la/.so}" 2>&1 /dev/null | grep " T " | cut -d" " -f3 ; done` ; do \
+		if test -f $(builddir)/man/$$symbol.html ; then \
+			echo "  Symbol $$symbol() is documented." ; \
+		else \
+			echo "‣ Symbol $$symbol() lacks documentation." ; \
+		fi ; \
+	 done