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.
This commit is contained in:
Alexandre Oliva 2014-11-21 02:06:19 -02:00
parent 7f0dfae0f2
commit a2b581cb25
3 changed files with 13 additions and 1 deletions

View file

@ -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.

View file

@ -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' ' -df -k 1,1 | tr '\014' '\012' \
> $(objpfx)summary-tmp
$(move-if-change) $(objpfx)summary-tmp $(objpfx)summary.texi

View file

@ -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' "$@" |