diff mbox

enable MTASC-safety sanity check in manual generation

Message ID or389va0jb.fsf@free.home
State Committed
Headers

Commit Message

Alexandre Oliva Nov. 7, 2014, 8:16 a.m. UTC 
  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(-)

Comments

Alexandre Oliva Nov. 19, 2014, 7:59 p.m. UTC | #1 
On Nov  7, 2014, Alexandre Oliva <aoliva@redhat.com> wrote:

> 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?

Ping?  I supose this is trivial enough that I could check it in without
a review by a third party, but I'll wait a couple more days just in
case.

> 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' "$@" |
Carlos O'Donell Nov. 19, 2014, 9:37 p.m. UTC | #2 
On 11/07/2014 03:16 AM, Alexandre Oliva wrote:
> 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.

While you say you are checking, all you did was add a FIXME? :-)

Adjust the ChangeLog to match reality and it's OK.

> 	* manual/Makefile ($(objpfx)stamp-summary): Require
> 	check-safety.sh to pass.

OK.

> ---
>  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 Nov. 21, 2014, 4:51 a.m. UTC | #3 
On Nov 19, 2014, "Carlos O'Donell" <carlos@redhat.com> wrote:

> On 11/07/2014 03:16 AM, Alexandre Oliva wrote:
>> * manual/check-safety.sh: Check that each @deftypefn or
>> @deftypefun is followed by a @safety remark.

> While you say you are checking, all you did was add a FIXME? :-)

Obviously I didn't *check* the ChangeLog entry either :-)

Thanks for catching this, here's the ChangeLog entry I'm using for the
check in:

	* 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.
Carlos O'Donell Nov. 21, 2014, 8:44 p.m. UTC | #4 
On 11/20/2014 11:51 PM, Alexandre Oliva wrote:
> On Nov 19, 2014, "Carlos O'Donell" <carlos@redhat.com> wrote:
> 
>> On 11/07/2014 03:16 AM, Alexandre Oliva wrote:
>>> * manual/check-safety.sh: Check that each @deftypefn or
>>> @deftypefun is followed by a @safety remark.
> 
>> While you say you are checking, all you did was add a FIXME? :-)
> 
> Obviously I didn't *check* the ChangeLog entry either :-)
> 
> Thanks for catching this, here's the ChangeLog entry I'm using for the
> check in:
> 
> 	* 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.
> 

LGTM :-)

c.
diff mbox

Patch

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