This is the mail archive of the libc-alpha@sourceware.org mailing list for the glibc project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

enable MTASC-safety sanity check in manual generation


I meant to post this shortly after the 2.19 release, but I forgot.

This is not expected to have any visible effect, but if anyone gets the
build to fail because of the error that was previously ignored, please
let me know, and I'll look into it.

Ok to install?


From: Alexandre Oliva <aoliva@redhat.com>

for  ChangeLog

	* manual/check-safety.sh: Check that each @deftypefn or
	@deftypefun is followed by a @safety remark.
	* manual/Makefile ($(objpfx)stamp-summary): Require
	check-safety.sh to pass.
---
 manual/Makefile        |    2 +-
 manual/check-safety.sh |    5 +++++
 2 files changed, 6 insertions(+), 1 deletion(-)

diff --git a/manual/Makefile b/manual/Makefile
index 62217a2..1f481f2 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 701624d..aaad313 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' "$@" |


-- 
Alexandre Oliva, freedom fighter    http://FSFLA.org/~lxoliva/
You must be the change you wish to see in the world. -- Gandhi
Be Free! -- http://FSFLA.org/   FSF Latin America board member
Free Software Evangelist|Red Hat Brasil GNU Toolchain Engineer


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]