Require check-safety.sh to pass; wish for check that all fns are documented

for  ChangeLog

	* manual/Makefile ($(objpfx)stamp-summary): Require
	check-safety.sh to pass.
	* manual/check-safety.sh: Wish for verification that every
	@deftypefn and @deftypefun is followed by a @safety remark.

diff --git a/ChangeLog b/ChangeLog
index 3f0cbbc7c122b58adbbca39894beeed5773d89ab..a83383ee06c568b661384c9f143cd427f1a770bb 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2014-11-21  Alexandre Oliva <aoliva@redhat.com>
+
+       * manual/Makefile ($(objpfx)stamp-summary): Require
+       check-safety.sh to pass.
+       * manual/check-safety.sh: Wish for verification that every
+       @deftypefn and @deftypefun is followed by a @safety remark.
+
 2014-11-20  Roland McGrath  <roland@hack.frob.com>
 
        * nptl/unwind.c (unwind_cleanup): Use __libc_fatal.

diff --git a/manual/Makefile b/manual/Makefile
index 62217a2d7a716382ca30da30049766ad9f9faf4d..1f481f251afd07a5e741bea50a9b0d87e74d0866 100644 (file)
--- a/manual/Makefile
+++ b/manual/Makefile
@@ -84,7 +84,7 @@ $(objpfx)libc/index.html: $(addprefix $(objpfx),$(libc-texi-generated))
 $(objpfx)summary.texi: $(objpfx)stamp-summary ;
 $(objpfx)stamp-summary: summary.awk $(filter-out $(objpfx)summary.texi, \
                                        $(texis-path))
-       -$(SHELL) ./check-safety.sh $(filter-out $(objpfx)%, $(texis-path))
+       $(SHELL) ./check-safety.sh $(filter-out $(objpfx)%, $(texis-path))
        $(AWK) -f $^ | sort -t'\f' -df -k 1,1 | tr '\014' '\012' \
                > $(objpfx)summary-tmp
        $(move-if-change) $(objpfx)summary-tmp $(objpfx)summary.texi

diff --git a/manual/check-safety.sh b/manual/check-safety.sh
index 701624d3b15352ba422820027b4f04cb2cb9ce10..aaad313c0817b07f4e81473dae1442e691568429 100644 (file)
--- a/manual/check-safety.sh
+++ b/manual/check-safety.sh
@@ -30,6 +30,11 @@ success=:
 # If no arguments are given, take all *.texi files in the current directory.
 test $# != 0 || set *.texi
 
+# FIXME: check that each @deftypefu?n is followed by a @safety note,
+# with nothing but @deftypefu?nx and comment lines in between.  (There
+# might be more stuff too).
+
+
 # Check that all safety remarks have entries for all of MT, AS and AC,
 # in this order, with an optional prelim note before them.
 grep -n '^@safety' "$@" |