diff options
| author | Alexandre Oliva <aoliva@redhat.com> | 2014-11-21 02:06:19 -0200 |
|---|---|---|
| committer | Alexandre Oliva <aoliva@redhat.com> | 2014-11-21 02:06:19 -0200 |
| commit | a2b581cb2550391f719268e72f031322215661f7 (patch) | |
| tree | eaa712bba940278a3e3ecd035b3d9913a9c442cf /manual | |
| parent | 7f0dfae0f26b3f72313ef255b86962a114ec7eed (diff) | |
| download | glibc-a2b581cb2550391f719268e72f031322215661f7.tar.gz glibc-a2b581cb2550391f719268e72f031322215661f7.tar.xz glibc-a2b581cb2550391f719268e72f031322215661f7.zip | |
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.
Diffstat (limited to 'manual')
| -rw-r--r-- | manual/Makefile | 2 | ||||
| -rw-r--r-- | manual/check-safety.sh | 5 |
2 files changed, 6 insertions, 1 deletions
diff --git a/manual/Makefile b/manual/Makefile index 62217a2d7a..1f481f251a 100644 --- 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' ' -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 701624d3b1..aaad313c08 100644 --- 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' "$@" | |