Skip to content

Commit

Permalink
Require check-safety.sh to pass; wish for check that all fns are docu…
Browse files Browse the repository at this point in the history
…mented

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.
  • Loading branch information
Alexandre Oliva committed Nov 21, 2014
1 parent 7f0dfae commit a2b581c
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 1 deletion.
7 changes: 7 additions & 0 deletions ChangeLog
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion manual/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions manual/check-safety.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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' "$@" |
Expand Down

0 comments on commit a2b581c

Please sign in to comment.