* [PATCH v2] Improve debugging for manual safety annotations
@ 2016-03-09 23:16 Juan Manuel Torres Palma
2016-03-10 9:46 ` ricaljasan
0 siblings, 1 reply; 9+ messages in thread
From: Juan Manuel Torres Palma @ 2016-03-09 23:16 UTC (permalink / raw)
To: libc-alpha; +Cc: aoliva
[-- Attachment #1: Type: text/plain, Size: 12529 bytes --]
hello glibc folks,
I have submitted and pinged this patch for quite a while already but I get no
feedback on it. Seems like I have to elaborate a little bit more on this patch
to get some review, so here we go.
This patch is quite simple since it barely changes anything critical. It
addresses a couple bugs that I spotted while writing documentation for new
features in the manual.
1.- Mention the option to build a pdf format of the manual in the
documentation.
2.- Fix bug in manual/errno.texi where the function perror(), that was labeled
as MT-safe, is actually MT-unsafe, due to race conditions when reading stderr.
It seemed to be a typo.
3.- Add awk script manual/chk-typefun.awk that ensures that every function
definition in the manual contains information about safety tags. It fixes a
FIXME marker set by Alexandre Oliva when creating this script.
4.- Add new debugging information to manual/check-safety.sh, so when building
the manual we can get to know which file and line contain the error. In
addition, a message with the type of error is displayed too. Fix a small bug in
this file that allowed to have MT-safe tags with Mt-Unsafe remarks.
As you can see, this patch is *not* critical, but fixes a couple things in the
manual that can help to write documentation for new functions in the future.
Please if you find any inconvenience, let me know and I will be glad to answer.
Cheers,
jmtp.
------------------------------------------------------
This patch improves previous safety tags checking script
and adds more output in case of errors. Also fixes a couple
bugs in the manual building system and adds a new file to
check that @deftypefun tags are always follown by @safety.
2016-03-10 Juan Manuel Torres Palma <j.m.torrespalma@gmail.com>
* INSTALL: Regenerated.
* manual/check-safety.sh: Fix bugs when finding AS-Unsafe tags
and add new debugging layer for this script.
* manual/chk-typefun.awk: New file. Searches for @deftypefun
that aren't paired with @safety annotations.
* manual/errno.texi (perror): Fix wrong tag.
* manual/install.texi: Add reference to 'make pdf'.
diff --git a/INSTALL b/INSTALL
index c70ea9f..ab46add 100644
--- a/INSTALL
+++ b/INSTALL
@@ -234,7 +234,8 @@ failure occurs.
'make dvi'. You need a working TeX installation to do this. The
distribution builds the on-line formatted version of the manual, as Info
files, as part of the build process. You can build them manually with
-'make info'.
+'make info'. Moreover, it's possible to get a copy in PDF format. To
+build it, type 'make pdf'.
The library has a number of special-purpose configuration parameters
which you can find in 'Makeconfig'. These can be overwritten with the
diff --git a/manual/check-safety.sh b/manual/check-safety.sh
index 2eba000..a3e08fe 100644
--- a/manual/check-safety.sh
+++ b/manual/check-safety.sh
@@ -24,23 +24,48 @@
# an explicit reason and when there's a reason for unsafety it's not
# safe, and that there aren't duplicates remarks.
-
+# Set to ":" if no error was found, and to "false" if found.
success=:
+# Gets the name of the file and line where an error was found.
+error_ln=
+
+# Holds the error message for an error.
+error_msg=
+
# 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).
+
+# Function to check errors and set $success.
+check_and_set_error ()
+{
+ if [ -n "$error_ln" ]
+ then
+ echo "$error_ln:Error $error_msg"
+ success=false
+ fi
+}
+
+
+# Check that each @deftypefu?n is followed by a @safety note,
+# with nothing but @deftypefu?nx and comment lines in between.
+# Also indexes are allowed.
+error_ln=$(awk -f chk-typefun.awk "$@")
+error_msg="unexpected tag between @deftypefun and @safety."
+check_and_set_error
# 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' "$@" |
+error_ln=$(grep -n '^@safety' "$@" |
grep -v ':@safety{\(@prelim{}\)\?@mt\(un\)\?safe{.*}'\
-'@as\(un\)\?safe{.*}@ac\(un\)\?safe{.*}}' &&
-success=false
+'@as\(un\)\?safe{.*}@ac\(un\)\?safe{.*}}' |
+cut -d':' -f1,2)
+
+error_msg="safety marks are in incorrect order (MT, AS, AC)."
+check_and_set_error
+
# Check that @mt-started notes appear within @mtsafe or @mtunsafe,
# that @as-started notes appear within @assafe or @asunsafe, and that
@@ -49,76 +74,108 @@ success=false
# unsafe), but let @mt have as, ac or asc before [su], and let @as
# have a c (for cancel) before [su]. Also make sure blanks separate
# each of the annotations.
-grep -n '^@safety' "$@" |
+error_ln=$(grep -n '^@safety' "$@" |
grep -v ':@safety{\(@prelim{}\)\?'\
'@mt\(un\)\?safe{\(@mt\(asc\?\|ac\)\?[su][^ ]*}\)\?'\
'\( @mt\(asc\?\|ac\)\?[su][^ ]*}\)*}'\
'@as\(un\)\?safe{\(@asc\?[su][^ ]*}\)\?'\
'\( @asc\?[su][^ ]*}\)*}'\
'@ac\(un\)\?safe{\(@ac[su][^ ]*}\)\?'\
-'\( @ac[su][^ ]*}\)*}}' &&
-success=false
+'\( @ac[su][^ ]*}\)*}}' |
+cut -d':' -f1,2)
+
+error_msg="tags are uncorrectly set. Check that every "\
+"remark is placed in the right tag."
+check_and_set_error
# Make sure safety lines marked as @mtsafe do not contain any
# MT-Unsafe remark; that would be @mtu, but there could be as, ac or
# asc between mt and u.
-grep -n '^@safety.*@mtsafe' "$@" |
-grep '@mt\(asc\?\|ac\)?u' "$@" &&
-success=false
+error_ln=$(grep -n '^@safety.*@mtsafe' "$@" |
+grep '@mt\(asc\?\|ac\)\?u' |
+cut -d':' -f1,2)
+
+error_msg="@mtsafe tag contains MT-Unsafe remark."
+check_and_set_error
# Make sure @mtunsafe lines contain at least one @mtu remark (with
# optional as, ac or asc between mt and u).
-grep -n '^@safety.*@mtunsafe' "$@" |
-grep -v '@mtunsafe{.*@mt\(asc\?\|ac\)\?u' &&
-success=false
+error_ln=$(grep -n '^@safety.*@mtunsafe' "$@" |
+grep -v '@mtunsafe{.*@mt\(asc\?\|ac\)\?u' |
+cut -d':' -f1,2)
+
+error_msg="@mtunsafe tag empty."
+check_and_set_error
# Make sure safety lines marked as @assafe do not contain any AS-Unsafe
# remark, which could be @asu or @mtasu note (with an optional c
# between as and u in both cases).
-grep -n '^@safety.*@assafe' "$@" |
-grep '@\(mt\)\?asc\?u' &&
-success=false
+error_ln=$(grep -n '^@safety.*@assafe' "$@" |
+grep '@\(mt\)\?asc\?u' |
+cut -d':' -f1,2)
+
+error_msg="@assafe tag contains AS-Unsafe remark."
+check_and_set_error
# Make sure @asunsafe lines contain at least one @asu remark (which
# could be @ascu, or @mtasu or even @mtascu).
-grep -n '^@safety.*@asunsafe' "$@" |
-grep -v '@mtasc\?u.*@asunsafe\|@asunsafe{.*@asc\?u' &&
-success=false
+error_ln=$(grep -n '^@safety.*@asunsafe' "$@" |
+grep -v '@mtasc\?u.*@asunsafe\|@asunsafe{.*@asc\?u' |
+cut -d':' -f1,2)
+
+error_msg="@asunsafe tag empty."
+check_and_set_error
# Make sure safety lines marked as @acsafe do not contain any
# AC-Unsafe remark, which could be @acu, @ascu or even @mtacu or
# @mtascu.
-grep -n '^@safety.*@acsafe' "$@" |
-grep '@\(mt\)\?as\?cu' &&
-success=false
+error_ln=$(grep -n '^@safety.*@acsafe' "$@" |
+grep '@\(mt\)\?as\?cu' |
+cut -d':' -f1,2)
+
+error_msg="@acsafe tag contains AC-Unsafe remark."
+check_and_set_error
# Make sure @acunsafe lines contain at least one @acu remark (possibly
# implied by @ascu, @mtacu or @mtascu).
-grep -n '^@safety.*@acunsafe' "$@" |
-grep -v '@\(mtas\?\|as\)cu.*@acunsafe\|@acunsafe{.*@acu' &&
-success=false
+error_ln=$(grep -n '^@safety.*@acunsafe' "$@" |
+grep -v '@\(mtas\?\|as\)cu.*@acunsafe\|@acunsafe{.*@acu' |
+cut -d':' -f1,2)
+
+error_msg="@acunsafe tag empty."
+check_and_set_error
# Make sure there aren't duplicate remarks in the same safety note.
-grep -n '^@safety' "$@" |
-grep '[^:]\(@\(mt\|a[sc]\)[^ {]*{[^ ]*}\).*[^:]\1' &&
-success=false
+error_ln=$(grep -n '^@safety' "$@" |
+grep '[^:]\(@\(mt\|a[sc]\)[^ {]*{[^ ]*}\).*[^:]\1' |
+cut -d':' -f1,2)
+
+error_msg="duplicated remark."
+check_and_set_error
# Check that comments containing safety remarks do not contain {}s,
# that all @mt remarks appear before @as remarks, that in turn appear
# before @ac remarks, all properly blank-separated, and that an
# optional comment about exclusions is between []s at the end of the
# line.
-grep -n '^@c \+[^@ ]\+\( dup\)\?'\
+error_ln=$(grep -n '^@c \+[^@ ]\+\( dup\)\?'\
'\( @\(mt\|a[sc]\)[^ ]*\)*\( \[.*\]\)\?$' "$@" |
grep -v ':@c *[^@{}]*\( @mt[^ {}]*\)*'\
-'\( @as[^ {}]*\)*\( @ac[^ {}]*\)*\( \[.*\]\)\?$' &&
-success=false
+'\( @as[^ {}]*\)*\( @ac[^ {}]*\)*\( \[.*\]\)\?$' |
+cut -d':' -f1,2)
+
+error_msg="safety remark in wrong order (@mt, @as, @ac), no space "\
+"between remarks or bad format for optional comment."
+check_and_set_error
# Check that comments containing safety remarks do not contain
# duplicate remarks.
-grep -n '^@c \+[^@ ]\+\( dup\)\?'\
+error_ln=$(grep -n '^@c \+[^@ ]\+\( dup\)\?'\
'\( @\(mt\|a[sc]\)[^ ]*\)*\( \[.*\]\)\?$' "$@" |
-grep '[^:]\(@\(mt\|a[sc]\)[^ ]*\) \(.*[^:]\)\?\1\($\| \)' &&
-success=false
+grep '[^:]\(@\(mt\|a[sc]\)[^ ]*\) \(.*[^:]\)\?\1\($\| \)' |
+cut -d':' -f1,2)
+
+error_msg="duplicated remark in a comment."
+check_and_set_error
$success
diff --git a/manual/chk-typefun.awk b/manual/chk-typefun.awk
new file mode 100644
index 0000000..c895a69
--- /dev/null
+++ b/manual/chk-typefun.awk
@@ -0,0 +1,46 @@
+#! /usr/local/bin/gawk -f
+
+# Copyright 2016 Free Software Foundation, Inc.
+# This file is part of the GNU C Library.
+
+# The GNU C Library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+
+# The GNU C Library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+
+# You should have received a copy of the GNU Lesser General Public
+# License along with the GNU C Library; if not, see
+# <http://www.gnu.org/licenses/>.
+
+
+# Checks that every @deftypefun is follown by a @safety tag.
+# Displays an error in case it is not found.
+
+
+/^@deftypefun / {
+ # Found deftypefun
+
+ # Read next line. If they are comments, keep going.
+ getline inp
+ while (match (inp, "^@c(omment)? ") ||
+ match (inp, "^@deftypefunx ") ||
+ match (inp, "^@[cp]index ")) {
+
+ getline inp
+ }
+
+ # Done reading comments, it's a @safety tag or
+ # we have to report error.
+ if (!match (inp, "^@safety{")) {
+ printf "%s:%d\n", FILENAME, FNR
+ exit 1
+ }
+
+ # If we get here is because tags were correctly
+ # placed.
+}
diff --git a/manual/errno.texi b/manual/errno.texi
index 1068be3..b14db62 100644
--- a/manual/errno.texi
+++ b/manual/errno.texi
@@ -1335,7 +1335,7 @@ This function @code{strerror_r} is a GNU extension and it is declared in
@comment stdio.h
@comment ISO
@deftypefun void perror (const char *@var{message})
-@safety{@prelim{}@mtsafe{@mtasurace{:stderr}}@asunsafe{@asucorrupt{} @ascuintl{} @ascuheap{} @asulock{}}@acunsafe{@acucorrupt{} @aculock{} @acsmem{} @acsfd{}}}
+@safety{@prelim{}@mtunsafe{@mtasurace{:stderr}}@asunsafe{@asucorrupt{} @ascuintl{} @ascuheap{} @asulock{}}@acunsafe{@acucorrupt{} @aculock{} @acsmem{} @acsfd{}}}
@c Besides strerror_r's and some of fprintf's issues, if stderr is not
@c oriented yet, create a new stream with a dup of stderr's fd and write
@c to that instead of stderr, to avoid orienting it.
diff --git a/manual/install.texi b/manual/install.texi
index de9d270..1e8d323 100644
--- a/manual/install.texi
+++ b/manual/install.texi
@@ -266,7 +266,8 @@ To format the @cite{GNU C Library Reference Manual} for printing, type
@w{@code{make dvi}}. You need a working @TeX{} installation to do
this. The distribution builds the on-line formatted version of the
manual, as Info files, as part of the build process. You can build
-them manually with @w{@code{make info}}.
+them manually with @w{@code{make info}}. Moreover, it's possible
+to get a copy in PDF format. To build it, type @w{@code{make pdf}}.
The library has a number of special-purpose configuration parameters
which you can find in @file{Makeconfig}. These can be overwritten with
--
2.5.0
--
Juan Manuel Torres Palma
Student of MS in Computer Engineering at Universidad de Granada
[-- Attachment #2: v2-0001-Improve-debugging-for-manual-safety-annotations.patch --]
[-- Type: text/plain, Size: 11199 bytes --]
From 9fc285c439ab3684cc5416e794f33ec28dc434a5 Mon Sep 17 00:00:00 2001
From: Juan Manuel Torres Palma <j.m.torrespalma@gmail.com>
Date: Thu, 10 Mar 2016 00:05:13 +0100
Subject: [PATCH v2] Improve debugging for manual safety annotations
This patch improves previous safety tags checking script
and adds more output in case of errors. Also fixes a couple
bugs in the manual building system and adds a new file to
check that @deftypefun tags are always follown by @safety.
2016-03-10 Juan Manuel Torres Palma <j.m.torrespalma@gmail.com>
* INSTALL: Regenerated.
* manual/check-safety.sh: Fix bugs when finding AS-Unsafe tags
and add new debugging layer for this script.
* manual/chk-typefun.awk: New file. Searches for @deftypefun
that aren't paired with @safety annotations.
* manual/errno.texi (perror): Fix wrong tag.
* manual/install.texi: Add reference to 'make pdf'.
diff --git a/INSTALL b/INSTALL
index c70ea9f..ab46add 100644
--- a/INSTALL
+++ b/INSTALL
@@ -234,7 +234,8 @@ failure occurs.
'make dvi'. You need a working TeX installation to do this. The
distribution builds the on-line formatted version of the manual, as Info
files, as part of the build process. You can build them manually with
-'make info'.
+'make info'. Moreover, it's possible to get a copy in PDF format. To
+build it, type 'make pdf'.
The library has a number of special-purpose configuration parameters
which you can find in 'Makeconfig'. These can be overwritten with the
diff --git a/manual/check-safety.sh b/manual/check-safety.sh
index 2eba000..a3e08fe 100644
--- a/manual/check-safety.sh
+++ b/manual/check-safety.sh
@@ -24,23 +24,48 @@
# an explicit reason and when there's a reason for unsafety it's not
# safe, and that there aren't duplicates remarks.
-
+# Set to ":" if no error was found, and to "false" if found.
success=:
+# Gets the name of the file and line where an error was found.
+error_ln=
+
+# Holds the error message for an error.
+error_msg=
+
# 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).
+
+# Function to check errors and set $success.
+check_and_set_error ()
+{
+ if [ -n "$error_ln" ]
+ then
+ echo "$error_ln:Error $error_msg"
+ success=false
+ fi
+}
+
+
+# Check that each @deftypefu?n is followed by a @safety note,
+# with nothing but @deftypefu?nx and comment lines in between.
+# Also indexes are allowed.
+error_ln=$(awk -f chk-typefun.awk "$@")
+error_msg="unexpected tag between @deftypefun and @safety."
+check_and_set_error
# 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' "$@" |
+error_ln=$(grep -n '^@safety' "$@" |
grep -v ':@safety{\(@prelim{}\)\?@mt\(un\)\?safe{.*}'\
-'@as\(un\)\?safe{.*}@ac\(un\)\?safe{.*}}' &&
-success=false
+'@as\(un\)\?safe{.*}@ac\(un\)\?safe{.*}}' |
+cut -d':' -f1,2)
+
+error_msg="safety marks are in incorrect order (MT, AS, AC)."
+check_and_set_error
+
# Check that @mt-started notes appear within @mtsafe or @mtunsafe,
# that @as-started notes appear within @assafe or @asunsafe, and that
@@ -49,76 +74,108 @@ success=false
# unsafe), but let @mt have as, ac or asc before [su], and let @as
# have a c (for cancel) before [su]. Also make sure blanks separate
# each of the annotations.
-grep -n '^@safety' "$@" |
+error_ln=$(grep -n '^@safety' "$@" |
grep -v ':@safety{\(@prelim{}\)\?'\
'@mt\(un\)\?safe{\(@mt\(asc\?\|ac\)\?[su][^ ]*}\)\?'\
'\( @mt\(asc\?\|ac\)\?[su][^ ]*}\)*}'\
'@as\(un\)\?safe{\(@asc\?[su][^ ]*}\)\?'\
'\( @asc\?[su][^ ]*}\)*}'\
'@ac\(un\)\?safe{\(@ac[su][^ ]*}\)\?'\
-'\( @ac[su][^ ]*}\)*}}' &&
-success=false
+'\( @ac[su][^ ]*}\)*}}' |
+cut -d':' -f1,2)
+
+error_msg="tags are uncorrectly set. Check that every "\
+"remark is placed in the right tag."
+check_and_set_error
# Make sure safety lines marked as @mtsafe do not contain any
# MT-Unsafe remark; that would be @mtu, but there could be as, ac or
# asc between mt and u.
-grep -n '^@safety.*@mtsafe' "$@" |
-grep '@mt\(asc\?\|ac\)?u' "$@" &&
-success=false
+error_ln=$(grep -n '^@safety.*@mtsafe' "$@" |
+grep '@mt\(asc\?\|ac\)\?u' |
+cut -d':' -f1,2)
+
+error_msg="@mtsafe tag contains MT-Unsafe remark."
+check_and_set_error
# Make sure @mtunsafe lines contain at least one @mtu remark (with
# optional as, ac or asc between mt and u).
-grep -n '^@safety.*@mtunsafe' "$@" |
-grep -v '@mtunsafe{.*@mt\(asc\?\|ac\)\?u' &&
-success=false
+error_ln=$(grep -n '^@safety.*@mtunsafe' "$@" |
+grep -v '@mtunsafe{.*@mt\(asc\?\|ac\)\?u' |
+cut -d':' -f1,2)
+
+error_msg="@mtunsafe tag empty."
+check_and_set_error
# Make sure safety lines marked as @assafe do not contain any AS-Unsafe
# remark, which could be @asu or @mtasu note (with an optional c
# between as and u in both cases).
-grep -n '^@safety.*@assafe' "$@" |
-grep '@\(mt\)\?asc\?u' &&
-success=false
+error_ln=$(grep -n '^@safety.*@assafe' "$@" |
+grep '@\(mt\)\?asc\?u' |
+cut -d':' -f1,2)
+
+error_msg="@assafe tag contains AS-Unsafe remark."
+check_and_set_error
# Make sure @asunsafe lines contain at least one @asu remark (which
# could be @ascu, or @mtasu or even @mtascu).
-grep -n '^@safety.*@asunsafe' "$@" |
-grep -v '@mtasc\?u.*@asunsafe\|@asunsafe{.*@asc\?u' &&
-success=false
+error_ln=$(grep -n '^@safety.*@asunsafe' "$@" |
+grep -v '@mtasc\?u.*@asunsafe\|@asunsafe{.*@asc\?u' |
+cut -d':' -f1,2)
+
+error_msg="@asunsafe tag empty."
+check_and_set_error
# Make sure safety lines marked as @acsafe do not contain any
# AC-Unsafe remark, which could be @acu, @ascu or even @mtacu or
# @mtascu.
-grep -n '^@safety.*@acsafe' "$@" |
-grep '@\(mt\)\?as\?cu' &&
-success=false
+error_ln=$(grep -n '^@safety.*@acsafe' "$@" |
+grep '@\(mt\)\?as\?cu' |
+cut -d':' -f1,2)
+
+error_msg="@acsafe tag contains AC-Unsafe remark."
+check_and_set_error
# Make sure @acunsafe lines contain at least one @acu remark (possibly
# implied by @ascu, @mtacu or @mtascu).
-grep -n '^@safety.*@acunsafe' "$@" |
-grep -v '@\(mtas\?\|as\)cu.*@acunsafe\|@acunsafe{.*@acu' &&
-success=false
+error_ln=$(grep -n '^@safety.*@acunsafe' "$@" |
+grep -v '@\(mtas\?\|as\)cu.*@acunsafe\|@acunsafe{.*@acu' |
+cut -d':' -f1,2)
+
+error_msg="@acunsafe tag empty."
+check_and_set_error
# Make sure there aren't duplicate remarks in the same safety note.
-grep -n '^@safety' "$@" |
-grep '[^:]\(@\(mt\|a[sc]\)[^ {]*{[^ ]*}\).*[^:]\1' &&
-success=false
+error_ln=$(grep -n '^@safety' "$@" |
+grep '[^:]\(@\(mt\|a[sc]\)[^ {]*{[^ ]*}\).*[^:]\1' |
+cut -d':' -f1,2)
+
+error_msg="duplicated remark."
+check_and_set_error
# Check that comments containing safety remarks do not contain {}s,
# that all @mt remarks appear before @as remarks, that in turn appear
# before @ac remarks, all properly blank-separated, and that an
# optional comment about exclusions is between []s at the end of the
# line.
-grep -n '^@c \+[^@ ]\+\( dup\)\?'\
+error_ln=$(grep -n '^@c \+[^@ ]\+\( dup\)\?'\
'\( @\(mt\|a[sc]\)[^ ]*\)*\( \[.*\]\)\?$' "$@" |
grep -v ':@c *[^@{}]*\( @mt[^ {}]*\)*'\
-'\( @as[^ {}]*\)*\( @ac[^ {}]*\)*\( \[.*\]\)\?$' &&
-success=false
+'\( @as[^ {}]*\)*\( @ac[^ {}]*\)*\( \[.*\]\)\?$' |
+cut -d':' -f1,2)
+
+error_msg="safety remark in wrong order (@mt, @as, @ac), no space "\
+"between remarks or bad format for optional comment."
+check_and_set_error
# Check that comments containing safety remarks do not contain
# duplicate remarks.
-grep -n '^@c \+[^@ ]\+\( dup\)\?'\
+error_ln=$(grep -n '^@c \+[^@ ]\+\( dup\)\?'\
'\( @\(mt\|a[sc]\)[^ ]*\)*\( \[.*\]\)\?$' "$@" |
-grep '[^:]\(@\(mt\|a[sc]\)[^ ]*\) \(.*[^:]\)\?\1\($\| \)' &&
-success=false
+grep '[^:]\(@\(mt\|a[sc]\)[^ ]*\) \(.*[^:]\)\?\1\($\| \)' |
+cut -d':' -f1,2)
+
+error_msg="duplicated remark in a comment."
+check_and_set_error
$success
diff --git a/manual/chk-typefun.awk b/manual/chk-typefun.awk
new file mode 100644
index 0000000..c895a69
--- /dev/null
+++ b/manual/chk-typefun.awk
@@ -0,0 +1,46 @@
+#! /usr/local/bin/gawk -f
+
+# Copyright 2016 Free Software Foundation, Inc.
+# This file is part of the GNU C Library.
+
+# The GNU C Library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+
+# The GNU C Library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+
+# You should have received a copy of the GNU Lesser General Public
+# License along with the GNU C Library; if not, see
+# <http://www.gnu.org/licenses/>.
+
+
+# Checks that every @deftypefun is follown by a @safety tag.
+# Displays an error in case it is not found.
+
+
+/^@deftypefun / {
+ # Found deftypefun
+
+ # Read next line. If they are comments, keep going.
+ getline inp
+ while (match (inp, "^@c(omment)? ") ||
+ match (inp, "^@deftypefunx ") ||
+ match (inp, "^@[cp]index ")) {
+
+ getline inp
+ }
+
+ # Done reading comments, it's a @safety tag or
+ # we have to report error.
+ if (!match (inp, "^@safety{")) {
+ printf "%s:%d\n", FILENAME, FNR
+ exit 1
+ }
+
+ # If we get here is because tags were correctly
+ # placed.
+}
diff --git a/manual/errno.texi b/manual/errno.texi
index 1068be3..b14db62 100644
--- a/manual/errno.texi
+++ b/manual/errno.texi
@@ -1335,7 +1335,7 @@ This function @code{strerror_r} is a GNU extension and it is declared in
@comment stdio.h
@comment ISO
@deftypefun void perror (const char *@var{message})
-@safety{@prelim{}@mtsafe{@mtasurace{:stderr}}@asunsafe{@asucorrupt{} @ascuintl{} @ascuheap{} @asulock{}}@acunsafe{@acucorrupt{} @aculock{} @acsmem{} @acsfd{}}}
+@safety{@prelim{}@mtunsafe{@mtasurace{:stderr}}@asunsafe{@asucorrupt{} @ascuintl{} @ascuheap{} @asulock{}}@acunsafe{@acucorrupt{} @aculock{} @acsmem{} @acsfd{}}}
@c Besides strerror_r's and some of fprintf's issues, if stderr is not
@c oriented yet, create a new stream with a dup of stderr's fd and write
@c to that instead of stderr, to avoid orienting it.
diff --git a/manual/install.texi b/manual/install.texi
index de9d270..1e8d323 100644
--- a/manual/install.texi
+++ b/manual/install.texi
@@ -266,7 +266,8 @@ To format the @cite{GNU C Library Reference Manual} for printing, type
@w{@code{make dvi}}. You need a working @TeX{} installation to do
this. The distribution builds the on-line formatted version of the
manual, as Info files, as part of the build process. You can build
-them manually with @w{@code{make info}}.
+them manually with @w{@code{make info}}. Moreover, it's possible
+to get a copy in PDF format. To build it, type @w{@code{make pdf}}.
The library has a number of special-purpose configuration parameters
which you can find in @file{Makeconfig}. These can be overwritten with
--
2.5.0
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [PATCH v2] Improve debugging for manual safety annotations
2016-03-09 23:16 [PATCH v2] Improve debugging for manual safety annotations Juan Manuel Torres Palma
@ 2016-03-10 9:46 ` ricaljasan
2016-03-14 12:01 ` Juan Manuel Torres Palma
0 siblings, 1 reply; 9+ messages in thread
From: ricaljasan @ 2016-03-10 9:46 UTC (permalink / raw)
To: Juan Manuel Torres Palma; +Cc: aoliva, libc-alpha
On 03/09/2016 03:16 PM, Juan Manuel Torres Palma wrote:
> hello glibc folks,
>
> I have submitted and pinged this patch for quite a while already but I get no
> feedback on it.
I'll try to help.
> diff --git a/manual/check-safety.sh b/manual/check-safety.sh
> index 2eba000..a3e08fe 100644
> --- a/manual/check-safety.sh
> +++ b/manual/check-safety.sh
> @@ -24,23 +24,48 @@
> # an explicit reason and when there's a reason for unsafety it's not
> # safe, and that there aren't duplicates remarks.
>
> -
> +# Set to ":" if no error was found, and to "false" if found.
> success=:
Really, initialized to ":", but maybe that's too nit-picky. I would say
something like, 'Initialize to ":", set to "false" on error.'
> +# Gets the name of the file and line where an error was found.
> +error_ln=
Maybe "holds" here as well? Would be consistent with below, and more
correct.
> +
> +# Holds the error message for an error.
> +error_msg=
> +
> # 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).
> +
> +# Function to check errors and set $success.
> +check_and_set_error ()
> +{
> + if [ -n "$error_ln" ]
> + then
> + echo "$error_ln:Error $error_msg"
Should be "$error_ln: $error_msg". Needs a space after the colon and
"Error" wouldn't be capitalized in any case, but simply using the
uncapitalized message below is correct, per GNU Coding Standards [1].
> + success=false
> + fi
> +}
> +
> +
> +# Check that each @deftypefu?n is followed by a @safety note,
> +# with nothing but @deftypefu?nx and comment lines in between.
> +# Also indexes are allowed.
> +error_ln=$(awk -f chk-typefun.awk "$@")
> +error_msg="unexpected tag between @deftypefun and @safety."
No period at end of message [1].
> +check_and_set_error
>
>
> # 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' "$@" |
> +error_ln=$(grep -n '^@safety' "$@" |
In the awk script, you matched on "^@safety{", which seemed like a wise
choice.
> grep -v ':@safety{\(@prelim{}\)\?@mt\(un\)\?safe{.*}'\
> -'@as\(un\)\?safe{.*}@ac\(un\)\?safe{.*}}' &&
> -success=false
> +'@as\(un\)\?safe{.*}@ac\(un\)\?safe{.*}}' |
I wonder if there would be any benefit to being stricter here, and
anchoring the end. Nothing in manual/*.texi violates it at the moment,
though.
Also, there aren't any preliminary comments anywhere in the manual that
would currently require matching @prelim{.*}, but I've always wondered
about it. manual/macros.texi adds an ugly, useless colon (useless
because it ignores any comment, which means the colon is always
immediately followed by a pipe), but it is still technically possible to
provide a comment in the @prelim macro even though it won't be rendered,
so it is valid to have "@prelim{foo}" somewhere.
> +cut -d':' -f1,2)
> +
> +error_msg="safety marks are in incorrect order (MT, AS, AC)."
Or something was absent, etc. I would just say, "Invalid @safety
command", because the test above is pretty broad.
Regardless, no period [1].
> +check_and_set_error
> +
> # Check that @mt-started notes appear within @mtsafe or @mtunsafe,
> # that @as-started notes appear within @assafe or @asunsafe, and that
> @@ -49,76 +74,108 @@ success=false
> # unsafe), but let @mt have as, ac or asc before [su], and let @as
> # have a c (for cancel) before [su]. Also make sure blanks separate
> # each of the annotations.
> -grep -n '^@safety' "$@" |
> +error_ln=$(grep -n '^@safety' "$@" |
I like "^@safety{".
> grep -v ':@safety{\(@prelim{}\)\?'\
Same caveat for @prelim.
> '@mt\(un\)\?safe{\(@mt\(asc\?\|ac\)\?[su][^ ]*}\)\?'\
> '\( @mt\(asc\?\|ac\)\?[su][^ ]*}\)*}'\
> '@as\(un\)\?safe{\(@asc\?[su][^ ]*}\)\?'\
> '\( @asc\?[su][^ ]*}\)*}'\
> '@ac\(un\)\?safe{\(@ac[su][^ ]*}\)\?'\
> -'\( @ac[su][^ ]*}\)*}}' &&
> -success=false
> +'\( @ac[su][^ ]*}\)*}}' |
> +cut -d':' -f1,2)
For the record, I did analyse this, despite it being unchanged, and it
looks reasonable, and nothing currently violates it.
> +
> +error_msg="tags are uncorrectly set. Check that every "\
incorrectly
> +"remark is placed in the right tag."
[1] doesn't explicitly address multiple phrases/sentences in the
message, but I'd assume "Check" is correct here, in which case both
periods would be correct, because there is a conceptual sentence
(although [1] seems adamant about not ending with a period). Thoughts
otherwise?
> +check_and_set_error
>
> # Make sure safety lines marked as @mtsafe do not contain any
> # MT-Unsafe remark; that would be @mtu, but there could be as, ac or
> # asc between mt and u.
> -grep -n '^@safety.*@mtsafe' "$@" |
> -grep '@mt\(asc\?\|ac\)?u' "$@" &&
> -success=false
> +error_ln=$(grep -n '^@safety.*@mtsafe' "$@" |
If we're rewriting this anyway, I'd go with "@safety{.*@mtsafe{".
Is there a potential for @(mt|a[sc])(un)?safe commands to ever change
their syntax? They're defined in manual/macros.texi, so I would assume
they're fixed (enough), but a comment in that file about the regex
dependency in this syntax/correctness-checking script might be a good
idea, if the safety rules aren't defined anywhere else.
> +grep '@mt\(asc\?\|ac\)\?u' |
Generally, I wouldn't think simply checking for this in the output from
above guarantees we found an MT-Unsafe remark inside an MT-Safe
remark---it could be anywhere. However, we should have caught the
phrase improperly placed in the checks above (e.g., in an
A[SC]-(Un)?[Ss]afe remark), so this seems sufficient, fwiw. Similar
rationale applies for subsequent tests.
> +cut -d':' -f1,2)
> +
> +error_msg="@mtsafe tag contains MT-Unsafe remark."
No period [1].
> +check_and_set_error
> # Make sure @mtunsafe lines contain at least one @mtu remark (with
> # optional as, ac or asc between mt and u).
> -grep -n '^@safety.*@mtunsafe' "$@" |
> -grep -v '@mtunsafe{.*@mt\(asc\?\|ac\)\?u' &&
> -success=false
> +error_ln=$(grep -n '^@safety.*@mtunsafe' "$@" |
^@safety{.*@mtunsafe{ (braces)
> +grep -v '@mtunsafe{.*@mt\(asc\?\|ac\)\?u' |
> +cut -d':' -f1,2)
> +
> +error_msg="@mtunsafe tag empty."
No period [1].
> +check_and_set_error
>
> # Make sure safety lines marked as @assafe do not contain any AS-Unsafe
> # remark, which could be @asu or @mtasu note (with an optional c
> # between as and u in both cases).
> -grep -n '^@safety.*@assafe' "$@" |
> -grep '@\(mt\)\?asc\?u' &&
> -success=false
> +error_ln=$(grep -n '^@safety.*@assafe' "$@" |
^@safety{.*@assafe{ (braces)
> +grep '@\(mt\)\?asc\?u' |
> +cut -d':' -f1,2)
> +
> +error_msg="@assafe tag contains AS-Unsafe remark."
No period [1]. (What do we say when this needs to happen in most, if
not all, cases below?)
> +check_and_set_error
>
> # Make sure @asunsafe lines contain at least one @asu remark (which
> # could be @ascu, or @mtasu or even @mtascu).
> -grep -n '^@safety.*@asunsafe' "$@" |
> -grep -v '@mtasc\?u.*@asunsafe\|@asunsafe{.*@asc\?u' &&
> -success=false
> +error_ln=$(grep -n '^@safety.*@asunsafe' "$@" |
> +grep -v '@mtasc\?u.*@asunsafe\|@asunsafe{.*@asc\?u' |
@mtasc\?u.*@asunsafe{\|@asunsafe{.*@asc\?u (brace)
> +cut -d':' -f1,2)
> +
> +error_msg="@asunsafe tag empty."
No period [1].
> +check_and_set_error
>
> # Make sure safety lines marked as @acsafe do not contain any
> # AC-Unsafe remark, which could be @acu, @ascu or even @mtacu or
> # @mtascu.
> -grep -n '^@safety.*@acsafe' "$@" |
> -grep '@\(mt\)\?as\?cu' &&
> -success=false
> +error_ln=$(grep -n '^@safety.*@acsafe' "$@" |
^@safety{.*@acsafe{ (braces)
> +grep '@\(mt\)\?as\?cu' |
> +cut -d':' -f1,2)
> +
> +error_msg="@acsafe tag contains AC-Unsafe remark."
No period [1].
> +check_and_set_error
>
> # Make sure @acunsafe lines contain at least one @acu remark (possibly
> # implied by @ascu, @mtacu or @mtascu).
> -grep -n '^@safety.*@acunsafe' "$@" |
> -grep -v '@\(mtas\?\|as\)cu.*@acunsafe\|@acunsafe{.*@acu' &&
> -success=false
> +error_ln=$(grep -n '^@safety.*@acunsafe' "$@" |
^@safety{.*@acunsafe{ (braces)
> +grep -v '@\(mtas\?\|as\)cu.*@acunsafe\|@acunsafe{.*@acu' |
> +cut -d':' -f1,2)
> +
> +error_msg="@acunsafe tag empty."
No period [1].
> +check_and_set_error
>
> # Make sure there aren't duplicate remarks in the same safety note.
> -grep -n '^@safety' "$@" |
> -grep '[^:]\(@\(mt\|a[sc]\)[^ {]*{[^ ]*}\).*[^:]\1' &&
> -success=false
> +error_ln=$(grep -n '^@safety' "$@" |
^@safety{
> +grep '[^:]\(@\(mt\|a[sc]\)[^ {]*{[^ ]*}\).*[^:]\1' |
> +cut -d':' -f1,2)
> +
> +error_msg="duplicated remark."
No period [1].
> +check_and_set_error
>
> # Check that comments containing safety remarks do not contain {}s,
> # that all @mt remarks appear before @as remarks, that in turn appear
> # before @ac remarks, all properly blank-separated, and that an
> # optional comment about exclusions is between []s at the end of the
> # line.
> -grep -n '^@c \+[^@ ]\+\( dup\)\?'\
> +error_ln=$(grep -n '^@c \+[^@ ]\+\( dup\)\?'\
> '\( @\(mt\|a[sc]\)[^ ]*\)*\( \[.*\]\)\?$' "$@" |
> grep -v ':@c *[^@{}]*\( @mt[^ {}]*\)*'\
> -'\( @as[^ {}]*\)*\( @ac[^ {}]*\)*\( \[.*\]\)\?$' &&
> -success=false
> +'\( @as[^ {}]*\)*\( @ac[^ {}]*\)*\( \[.*\]\)\?$' |
> +cut -d':' -f1,2)
I don't quite understand why the syntax in comments matters here, but
seeing as how this maintains the status quo, sure.
Comments could technically be "@c(omment)?", though [2].
Also, there are a few lines that look to be comments containing an
@safety remark and {}s, but aren't matched in the above test (grep
'^@c.*@safety{' manual/*.texi).
Other supposed conditions untested.
> +
> +error_msg="safety remark in wrong order (@mt, @as, @ac), no space "\
> +"between remarks or bad format for optional comment."
No period [1]. Also, not sure the test is accurate for either the
comment or message.
> +check_and_set_error
>
> # Check that comments containing safety remarks do not contain
> # duplicate remarks.
> -grep -n '^@c \+[^@ ]\+\( dup\)\?'\
> +error_ln=$(grep -n '^@c \+[^@ ]\+\( dup\)\?'\
> '\( @\(mt\|a[sc]\)[^ ]*\)*\( \[.*\]\)\?$' "$@" |
> -grep '[^:]\(@\(mt\|a[sc]\)[^ ]*\) \(.*[^:]\)\?\1\($\| \)' &&
> -success=false
> +grep '[^:]\(@\(mt\|a[sc]\)[^ ]*\) \(.*[^:]\)\?\1\($\| \)' |
> +cut -d':' -f1,2)
In lieu of the comment-syntax relevancy question, untested.
> +
> +error_msg="duplicated remark in a comment."
No period [1].
> +check_and_set_error
>
> $success
> diff --git a/manual/chk-typefun.awk b/manual/chk-typefun.awk
> new file mode 100644
> index 0000000..c895a69
> --- /dev/null
> +++ b/manual/chk-typefun.awk
> @@ -0,0 +1,46 @@
> +#! /usr/local/bin/gawk -f
Do we really assume gawk is in /usr/local? I see one other script does
(manual/xtract-typefun.awk), and 3 others use /usr/bin/awk, and only
those 4 of 36 *.awk scripts have the shebang.
> +
> +# Copyright 2016 Free Software Foundation, Inc.
> +# This file is part of the GNU C Library.
> +
> +# The GNU C Library is free software; you can redistribute it and/or
> +# modify it under the terms of the GNU Lesser General Public
> +# License as published by the Free Software Foundation; either
> +# version 2.1 of the License, or (at your option) any later version.
> +
> +# The GNU C Library is distributed in the hope that it will be useful,
> +# but WITHOUT ANY WARRANTY; without even the implied warranty of
> +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
> +# Lesser General Public License for more details.
> +
> +# You should have received a copy of the GNU Lesser General Public
> +# License along with the GNU C Library; if not, see
> +# <http://www.gnu.org/licenses/>.
> +
> +
> +# Checks that every @deftypefun is follown by a @safety tag.
followed
I think "an @safety tag" is correct, because it's read, "followed by an
at-safety tag." (I believe they're called "at-commands".) Again, maybe
too nit-picky, since using "a" implies you've chosen to pronounce
"@safety" as "safety" and not "at-safety".
> +# Displays an error in case it is not found.
> +
> +
> +/^@deftypefun / {
> + # Found deftypefun
> +
> + # Read next line. If they are comments, keep going.
> + getline inp
> + while (match (inp, "^@c(omment)? ") ||
> + match (inp, "^@deftypefunx ") ||
> + match (inp, "^@[cp]index ")) {
> +
> + getline inp
> + }
> +
> + # Done reading comments, it's a @safety tag or
Possibly "an".
> + # we have to report error.
"an error" :)
> + if (!match (inp, "^@safety{")) {
> + printf "%s:%d\n", FILENAME, FNR
> + exit 1
> + }
> +
> + # If we get here is because tags were correctly
> + # placed.
> +}
I like it. If we're putting this in a variable (error_ln) that is
getting prefixed to a message, do we really want/need the trailing newline?
> diff --git a/manual/install.texi b/manual/install.texi
> index de9d270..1e8d323 100644
> --- a/manual/install.texi
> +++ b/manual/install.texi
> @@ -266,7 +266,8 @@ To format the @cite{GNU C Library Reference Manual} for printing, type
> @w{@code{make dvi}}. You need a working @TeX{} installation to do
> this. The distribution builds the on-line formatted version of the
> manual, as Info files, as part of the build process. You can build
> -them manually with @w{@code{make info}}.
> +them manually with @w{@code{make info}}. Moreover, it's possible
> +to get a copy in PDF format. To build it, type @w{@code{make pdf}}.
I appreciate this inclusion, and would like to point out it's possible
to `make html' as well.
Perhaps the `make pdf' mention should be moved closer to dvi, since it
has the same caveat (manual/Makefile):
TEXI2DVI = texi2dvi
TEXI2PDF = texi2dvi --pdf
rj
----
[1] https://www.gnu.org/prep/standards/html_node/Errors.html
[2]
https://www.gnu.org/software/texinfo/manual/texinfo/html_node/Comments.html
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [PATCH v2] Improve debugging for manual safety annotations
2016-03-10 9:46 ` ricaljasan
@ 2016-03-14 12:01 ` Juan Manuel Torres Palma
0 siblings, 0 replies; 9+ messages in thread
From: Juan Manuel Torres Palma @ 2016-03-14 12:01 UTC (permalink / raw)
To: ricaljasan; +Cc: aoliva, libc-alpha
> I'll try to help.
Your help is really appreciated :)
> > +check_and_set_error ()
> > +{
> > + if [ -n "$error_ln" ]
> > + then
> > + echo "$error_ln:Error $error_msg"
>
> Should be "$error_ln: $error_msg". Needs a space after the colon and
> "Error" wouldn't be capitalized in any case, but simply using the
> uncapitalized message below is correct, per GNU Coding Standards [1].
I wasn't really aware of the error format by the GNU Coding Standards, so was
a mistake by my side, fixed in the next version of the patch.
> > +error_msg="unexpected tag between @deftypefun and @safety."
>
> No period at end of message [1].
Likewise.
> > -grep -n '^@safety' "$@" |
> > +error_ln=$(grep -n '^@safety' "$@" |
>
> In the awk script, you matched on "^@safety{", which seemed like a wise
> choice.
It was inherited code from the previous version, but yeah, if I'm changing it I
can definitely add the '{'.
> immediately followed by a pipe), but it is still technically possible to
> provide a comment in the @prelim macro even though it won't be rendered,
> so it is valid to have "@prelim{foo}" somewhere.
>
I didn't know it was possible, so added to new patch.
> > +
> > +error_msg="tags are uncorrectly set. Check that every "\
>
> incorrectly
>
As you can see some mistakes are caused by bad English.
> > +"remark is placed in the right tag."
>
> [1] doesn't explicitly address multiple phrases/sentences in the
> message, but I'd assume "Check" is correct here, in which case both
> periods would be correct, because there is a conceptual sentence
> (although [1] seems adamant about not ending with a period). Thoughts
> otherwise?
My solution so far has been shortening the messages and separate statements
with comma. A couple of examples of this are:
error_msg="tags are incorrectly set, a remark may be placed "\
"in the wrong tag"
error_msg="invalid @safety command, a remark may be missing "\
"or in incorrect order"
Maybe not the best solution but probably more compact and sticks to error
reporting standard better.
> > +#! /usr/local/bin/gawk -f
>
> Do we really assume gawk is in /usr/local? I see one other script does
> (manual/xtract-typefun.awk), and 3 others use /usr/bin/awk, and only
> those 4 of 36 *.awk scripts have the shebang.
>
Coincidentally, I took manual/xtract-typefun.awk as a model to create this one.
Actually I only used the shebang for debugging since it's called from
manual/check-safety.sh as 'awk -f chk-typefun.awk', so we don't really need it.
> > +# Checks that every @deftypefun is follown by a @safety tag.
>
> followed
>
> I think "an @safety tag" is correct, because it's read, "followed by an
> at-safety tag." (I believe they're called "at-commands".) Again, maybe
> too nit-picky, since using "a" implies you've chosen to pronounce
> "@safety" as "safety" and not "at-safety".
>
I used to read it as "safety", not "at-safety", but I get your point. I'll add
it to next patch.
> > + if (!match (inp, "^@safety{")) {
> > + printf "%s:%d\n", FILENAME, FNR
> > + exit 1
> > + }
> > +
> > + # If we get here is because tags were correctly
> > + # placed.
> > +}
>
> I like it. If we're putting this in a variable (error_ln) that is
> getting prefixed to a message, do we really want/need the trailing newline?
As before, I was using it for debugging and forgot to delete it for the final
version, thanks for pointing out.
--
Juan Manuel Torres Palma
Student of MS in Computer Engineering at Universidad de Granada
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [PATCH v2] Improve debugging for manual safety annotations
2016-02-11 19:23 Juan Manuel Torres Palma
@ 2016-02-22 18:29 ` Juan Manuel Torres Palma
0 siblings, 0 replies; 9+ messages in thread
From: Juan Manuel Torres Palma @ 2016-02-22 18:29 UTC (permalink / raw)
To: libc-alpha; +Cc: aoliva, Joseph S. Myers
Ping!
2016-02-11 20:22 GMT+01:00 Juan Manuel Torres Palma <j.m.torrespalma@gmail.com>:
> This patch improves previous safety tags checking script
> and adds more output in case of errors. Also fixes a couple
> bugs in the manual building system and adds a new file to
> check that @deftypefun tags are always follown by @safety.
>
> 2016-02-11 Juan Manuel Torres Palma <j.m.torrespalma@gmail.com>
>
> * INSTALL: Regenerated.
> * manual/check-safety.sh: Fix bugs when finding AS-Unsafe tags
> and add new debugging layer for this script.
> * manual/chk-typefun.awk: New file. Searches for @deftypefun
> that aren't paired with @safety annotations.
> * manual/errno.texi (perror): Fix wrong tag.
> * manual/install.texi: Add reference to 'make pdf'.
>
> diff --git a/INSTALL b/INSTALL
> index c70ea9f..ab46add 100644
> --- a/INSTALL
> +++ b/INSTALL
> @@ -234,7 +234,8 @@ failure occurs.
> 'make dvi'. You need a working TeX installation to do this. The
> distribution builds the on-line formatted version of the manual, as Info
> files, as part of the build process. You can build them manually with
> -'make info'.
> +'make info'. Moreover, it's possible to get a copy in PDF format. To
> +build it, type 'make pdf'.
>
> The library has a number of special-purpose configuration parameters
> which you can find in 'Makeconfig'. These can be overwritten with the
> diff --git a/manual/check-safety.sh b/manual/check-safety.sh
> index 2eba000..a3e08fe 100644
> --- a/manual/check-safety.sh
> +++ b/manual/check-safety.sh
> @@ -24,23 +24,48 @@
> # an explicit reason and when there's a reason for unsafety it's not
> # safe, and that there aren't duplicates remarks.
>
> -
> +# Set to ":" if no error was found, and to "false" if found.
> success=:
>
> +# Gets the name of the file and line where an error was found.
> +error_ln=
> +
> +# Holds the error message for an error.
> +error_msg=
> +
> # 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).
> +
> +# Function to check errors and set $success.
> +check_and_set_error ()
> +{
> + if [ -n "$error_ln" ]
> + then
> + echo "$error_ln:Error $error_msg"
> + success=false
> + fi
> +}
> +
> +
> +# Check that each @deftypefu?n is followed by a @safety note,
> +# with nothing but @deftypefu?nx and comment lines in between.
> +# Also indexes are allowed.
> +error_ln=$(awk -f chk-typefun.awk "$@")
> +error_msg="unexpected tag between @deftypefun and @safety."
> +check_and_set_error
>
>
> # 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' "$@" |
> +error_ln=$(grep -n '^@safety' "$@" |
> grep -v ':@safety{\(@prelim{}\)\?@mt\(un\)\?safe{.*}'\
> -'@as\(un\)\?safe{.*}@ac\(un\)\?safe{.*}}' &&
> -success=false
> +'@as\(un\)\?safe{.*}@ac\(un\)\?safe{.*}}' |
> +cut -d':' -f1,2)
> +
> +error_msg="safety marks are in incorrect order (MT, AS, AC)."
> +check_and_set_error
> +
>
> # Check that @mt-started notes appear within @mtsafe or @mtunsafe,
> # that @as-started notes appear within @assafe or @asunsafe, and that
> @@ -49,76 +74,108 @@ success=false
> # unsafe), but let @mt have as, ac or asc before [su], and let @as
> # have a c (for cancel) before [su]. Also make sure blanks separate
> # each of the annotations.
> -grep -n '^@safety' "$@" |
> +error_ln=$(grep -n '^@safety' "$@" |
> grep -v ':@safety{\(@prelim{}\)\?'\
> '@mt\(un\)\?safe{\(@mt\(asc\?\|ac\)\?[su][^ ]*}\)\?'\
> '\( @mt\(asc\?\|ac\)\?[su][^ ]*}\)*}'\
> '@as\(un\)\?safe{\(@asc\?[su][^ ]*}\)\?'\
> '\( @asc\?[su][^ ]*}\)*}'\
> '@ac\(un\)\?safe{\(@ac[su][^ ]*}\)\?'\
> -'\( @ac[su][^ ]*}\)*}}' &&
> -success=false
> +'\( @ac[su][^ ]*}\)*}}' |
> +cut -d':' -f1,2)
> +
> +error_msg="tags are uncorrectly set. Check that every "\
> +"remark is placed in the right tag."
> +check_and_set_error
>
> # Make sure safety lines marked as @mtsafe do not contain any
> # MT-Unsafe remark; that would be @mtu, but there could be as, ac or
> # asc between mt and u.
> -grep -n '^@safety.*@mtsafe' "$@" |
> -grep '@mt\(asc\?\|ac\)?u' "$@" &&
> -success=false
> +error_ln=$(grep -n '^@safety.*@mtsafe' "$@" |
> +grep '@mt\(asc\?\|ac\)\?u' |
> +cut -d':' -f1,2)
> +
> +error_msg="@mtsafe tag contains MT-Unsafe remark."
> +check_and_set_error
>
> # Make sure @mtunsafe lines contain at least one @mtu remark (with
> # optional as, ac or asc between mt and u).
> -grep -n '^@safety.*@mtunsafe' "$@" |
> -grep -v '@mtunsafe{.*@mt\(asc\?\|ac\)\?u' &&
> -success=false
> +error_ln=$(grep -n '^@safety.*@mtunsafe' "$@" |
> +grep -v '@mtunsafe{.*@mt\(asc\?\|ac\)\?u' |
> +cut -d':' -f1,2)
> +
> +error_msg="@mtunsafe tag empty."
> +check_and_set_error
>
> # Make sure safety lines marked as @assafe do not contain any AS-Unsafe
> # remark, which could be @asu or @mtasu note (with an optional c
> # between as and u in both cases).
> -grep -n '^@safety.*@assafe' "$@" |
> -grep '@\(mt\)\?asc\?u' &&
> -success=false
> +error_ln=$(grep -n '^@safety.*@assafe' "$@" |
> +grep '@\(mt\)\?asc\?u' |
> +cut -d':' -f1,2)
> +
> +error_msg="@assafe tag contains AS-Unsafe remark."
> +check_and_set_error
>
> # Make sure @asunsafe lines contain at least one @asu remark (which
> # could be @ascu, or @mtasu or even @mtascu).
> -grep -n '^@safety.*@asunsafe' "$@" |
> -grep -v '@mtasc\?u.*@asunsafe\|@asunsafe{.*@asc\?u' &&
> -success=false
> +error_ln=$(grep -n '^@safety.*@asunsafe' "$@" |
> +grep -v '@mtasc\?u.*@asunsafe\|@asunsafe{.*@asc\?u' |
> +cut -d':' -f1,2)
> +
> +error_msg="@asunsafe tag empty."
> +check_and_set_error
>
> # Make sure safety lines marked as @acsafe do not contain any
> # AC-Unsafe remark, which could be @acu, @ascu or even @mtacu or
> # @mtascu.
> -grep -n '^@safety.*@acsafe' "$@" |
> -grep '@\(mt\)\?as\?cu' &&
> -success=false
> +error_ln=$(grep -n '^@safety.*@acsafe' "$@" |
> +grep '@\(mt\)\?as\?cu' |
> +cut -d':' -f1,2)
> +
> +error_msg="@acsafe tag contains AC-Unsafe remark."
> +check_and_set_error
>
> # Make sure @acunsafe lines contain at least one @acu remark (possibly
> # implied by @ascu, @mtacu or @mtascu).
> -grep -n '^@safety.*@acunsafe' "$@" |
> -grep -v '@\(mtas\?\|as\)cu.*@acunsafe\|@acunsafe{.*@acu' &&
> -success=false
> +error_ln=$(grep -n '^@safety.*@acunsafe' "$@" |
> +grep -v '@\(mtas\?\|as\)cu.*@acunsafe\|@acunsafe{.*@acu' |
> +cut -d':' -f1,2)
> +
> +error_msg="@acunsafe tag empty."
> +check_and_set_error
>
> # Make sure there aren't duplicate remarks in the same safety note.
> -grep -n '^@safety' "$@" |
> -grep '[^:]\(@\(mt\|a[sc]\)[^ {]*{[^ ]*}\).*[^:]\1' &&
> -success=false
> +error_ln=$(grep -n '^@safety' "$@" |
> +grep '[^:]\(@\(mt\|a[sc]\)[^ {]*{[^ ]*}\).*[^:]\1' |
> +cut -d':' -f1,2)
> +
> +error_msg="duplicated remark."
> +check_and_set_error
>
> # Check that comments containing safety remarks do not contain {}s,
> # that all @mt remarks appear before @as remarks, that in turn appear
> # before @ac remarks, all properly blank-separated, and that an
> # optional comment about exclusions is between []s at the end of the
> # line.
> -grep -n '^@c \+[^@ ]\+\( dup\)\?'\
> +error_ln=$(grep -n '^@c \+[^@ ]\+\( dup\)\?'\
> '\( @\(mt\|a[sc]\)[^ ]*\)*\( \[.*\]\)\?$' "$@" |
> grep -v ':@c *[^@{}]*\( @mt[^ {}]*\)*'\
> -'\( @as[^ {}]*\)*\( @ac[^ {}]*\)*\( \[.*\]\)\?$' &&
> -success=false
> +'\( @as[^ {}]*\)*\( @ac[^ {}]*\)*\( \[.*\]\)\?$' |
> +cut -d':' -f1,2)
> +
> +error_msg="safety remark in wrong order (@mt, @as, @ac), no space "\
> +"between remarks or bad format for optional comment."
> +check_and_set_error
>
> # Check that comments containing safety remarks do not contain
> # duplicate remarks.
> -grep -n '^@c \+[^@ ]\+\( dup\)\?'\
> +error_ln=$(grep -n '^@c \+[^@ ]\+\( dup\)\?'\
> '\( @\(mt\|a[sc]\)[^ ]*\)*\( \[.*\]\)\?$' "$@" |
> -grep '[^:]\(@\(mt\|a[sc]\)[^ ]*\) \(.*[^:]\)\?\1\($\| \)' &&
> -success=false
> +grep '[^:]\(@\(mt\|a[sc]\)[^ ]*\) \(.*[^:]\)\?\1\($\| \)' |
> +cut -d':' -f1,2)
> +
> +error_msg="duplicated remark in a comment."
> +check_and_set_error
>
> $success
> diff --git a/manual/chk-typefun.awk b/manual/chk-typefun.awk
> new file mode 100644
> index 0000000..9d17078
> --- /dev/null
> +++ b/manual/chk-typefun.awk
> @@ -0,0 +1,46 @@
> +#! /usr/local/bin/gawk -f
> +
> +# Copyright 2016 Free Software Foundation, Inc.
> +# This file is part of the GNU C Library.
> +
> +# The GNU C Library is free software; you can redistribute it and/or
> +# modify it under the terms of the GNU Lesser General Public
> +# License as published by the Free Software Foundation; either
> +# version 2.1 of the License, or (at your option) any later version.
> +
> +# The GNU C Library is distributed in the hope that it will be useful,
> +# but WITHOUT ANY WARRANTY; without even the implied warranty of
> +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
> +# Lesser General Public License for more details.
> +
> +# You should have received a copy of the GNU Lesser General Public
> +# License along with the GNU C Library; if not, see
> +# <http://www.gnu.org/licenses/>.
> +
> +
> +# Checks that every @deftypefun is follown by a @safety tag.
> +# Displays an error in case it is not found.
> +
> +
> +/^@deftypefun / {
> + # Found deftypefun
> +
> + # Read next line. If they are comments, keep going.
> + getline inp
> + while (match (inp, "^@c(omment)? ") ||
> + match (inp, "^@deftypefunx ") ||
> + match (inp, "^@[cp]index ")) {
> +
> + getline inp
> + }
> +
> + # Done reading comments, it's a @safety tag or
> + # we have to report error.
> + if (!match (inp, "^@safety{")) {
> + printf "%s:%d\n", FILENAME, FNR
> + exit 1
> + }
> +
> + # If we get here is because tags were correctly
> + # placed.
> +}
> diff --git a/manual/errno.texi b/manual/errno.texi
> index 1068be3..b14db62 100644
> --- a/manual/errno.texi
> +++ b/manual/errno.texi
> @@ -1335,7 +1335,7 @@ This function @code{strerror_r} is a GNU extension and it is declared in
> @comment stdio.h
> @comment ISO
> @deftypefun void perror (const char *@var{message})
> -@safety{@prelim{}@mtsafe{@mtasurace{:stderr}}@asunsafe{@asucorrupt{} @ascuintl{} @ascuheap{} @asulock{}}@acunsafe{@acucorrupt{} @aculock{} @acsmem{} @acsfd{}}}
> +@safety{@prelim{}@mtunsafe{@mtasurace{:stderr}}@asunsafe{@asucorrupt{} @ascuintl{} @ascuheap{} @asulock{}}@acunsafe{@acucorrupt{} @aculock{} @acsmem{} @acsfd{}}}
> @c Besides strerror_r's and some of fprintf's issues, if stderr is not
> @c oriented yet, create a new stream with a dup of stderr's fd and write
> @c to that instead of stderr, to avoid orienting it.
> diff --git a/manual/install.texi b/manual/install.texi
> index de9d270..1e8d323 100644
> --- a/manual/install.texi
> +++ b/manual/install.texi
> @@ -266,7 +266,8 @@ To format the @cite{GNU C Library Reference Manual} for printing, type
> @w{@code{make dvi}}. You need a working @TeX{} installation to do
> this. The distribution builds the on-line formatted version of the
> manual, as Info files, as part of the build process. You can build
> -them manually with @w{@code{make info}}.
> +them manually with @w{@code{make info}}. Moreover, it's possible
> +to get a copy in PDF format. To build it, type @w{@code{make pdf}}.
>
> The library has a number of special-purpose configuration parameters
> which you can find in @file{Makeconfig}. These can be overwritten with
> --
> 2.5.0
>
--
Juan Manuel Torres Palma.
Computer Engineering Student at Universidad de Granada.
^ permalink raw reply [flat|nested] 9+ messages in thread
* [PATCH v2] Improve debugging for manual safety annotations
@ 2016-02-11 19:23 Juan Manuel Torres Palma
2016-02-22 18:29 ` Juan Manuel Torres Palma
0 siblings, 1 reply; 9+ messages in thread
From: Juan Manuel Torres Palma @ 2016-02-11 19:23 UTC (permalink / raw)
To: libc-alpha; +Cc: aoliva, joseph
This patch improves previous safety tags checking script
and adds more output in case of errors. Also fixes a couple
bugs in the manual building system and adds a new file to
check that @deftypefun tags are always follown by @safety.
2016-02-11 Juan Manuel Torres Palma <j.m.torrespalma@gmail.com>
* INSTALL: Regenerated.
* manual/check-safety.sh: Fix bugs when finding AS-Unsafe tags
and add new debugging layer for this script.
* manual/chk-typefun.awk: New file. Searches for @deftypefun
that aren't paired with @safety annotations.
* manual/errno.texi (perror): Fix wrong tag.
* manual/install.texi: Add reference to 'make pdf'.
diff --git a/INSTALL b/INSTALL
index c70ea9f..ab46add 100644
--- a/INSTALL
+++ b/INSTALL
@@ -234,7 +234,8 @@ failure occurs.
'make dvi'. You need a working TeX installation to do this. The
distribution builds the on-line formatted version of the manual, as Info
files, as part of the build process. You can build them manually with
-'make info'.
+'make info'. Moreover, it's possible to get a copy in PDF format. To
+build it, type 'make pdf'.
The library has a number of special-purpose configuration parameters
which you can find in 'Makeconfig'. These can be overwritten with the
diff --git a/manual/check-safety.sh b/manual/check-safety.sh
index 2eba000..a3e08fe 100644
--- a/manual/check-safety.sh
+++ b/manual/check-safety.sh
@@ -24,23 +24,48 @@
# an explicit reason and when there's a reason for unsafety it's not
# safe, and that there aren't duplicates remarks.
-
+# Set to ":" if no error was found, and to "false" if found.
success=:
+# Gets the name of the file and line where an error was found.
+error_ln=
+
+# Holds the error message for an error.
+error_msg=
+
# 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).
+
+# Function to check errors and set $success.
+check_and_set_error ()
+{
+ if [ -n "$error_ln" ]
+ then
+ echo "$error_ln:Error $error_msg"
+ success=false
+ fi
+}
+
+
+# Check that each @deftypefu?n is followed by a @safety note,
+# with nothing but @deftypefu?nx and comment lines in between.
+# Also indexes are allowed.
+error_ln=$(awk -f chk-typefun.awk "$@")
+error_msg="unexpected tag between @deftypefun and @safety."
+check_and_set_error
# 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' "$@" |
+error_ln=$(grep -n '^@safety' "$@" |
grep -v ':@safety{\(@prelim{}\)\?@mt\(un\)\?safe{.*}'\
-'@as\(un\)\?safe{.*}@ac\(un\)\?safe{.*}}' &&
-success=false
+'@as\(un\)\?safe{.*}@ac\(un\)\?safe{.*}}' |
+cut -d':' -f1,2)
+
+error_msg="safety marks are in incorrect order (MT, AS, AC)."
+check_and_set_error
+
# Check that @mt-started notes appear within @mtsafe or @mtunsafe,
# that @as-started notes appear within @assafe or @asunsafe, and that
@@ -49,76 +74,108 @@ success=false
# unsafe), but let @mt have as, ac or asc before [su], and let @as
# have a c (for cancel) before [su]. Also make sure blanks separate
# each of the annotations.
-grep -n '^@safety' "$@" |
+error_ln=$(grep -n '^@safety' "$@" |
grep -v ':@safety{\(@prelim{}\)\?'\
'@mt\(un\)\?safe{\(@mt\(asc\?\|ac\)\?[su][^ ]*}\)\?'\
'\( @mt\(asc\?\|ac\)\?[su][^ ]*}\)*}'\
'@as\(un\)\?safe{\(@asc\?[su][^ ]*}\)\?'\
'\( @asc\?[su][^ ]*}\)*}'\
'@ac\(un\)\?safe{\(@ac[su][^ ]*}\)\?'\
-'\( @ac[su][^ ]*}\)*}}' &&
-success=false
+'\( @ac[su][^ ]*}\)*}}' |
+cut -d':' -f1,2)
+
+error_msg="tags are uncorrectly set. Check that every "\
+"remark is placed in the right tag."
+check_and_set_error
# Make sure safety lines marked as @mtsafe do not contain any
# MT-Unsafe remark; that would be @mtu, but there could be as, ac or
# asc between mt and u.
-grep -n '^@safety.*@mtsafe' "$@" |
-grep '@mt\(asc\?\|ac\)?u' "$@" &&
-success=false
+error_ln=$(grep -n '^@safety.*@mtsafe' "$@" |
+grep '@mt\(asc\?\|ac\)\?u' |
+cut -d':' -f1,2)
+
+error_msg="@mtsafe tag contains MT-Unsafe remark."
+check_and_set_error
# Make sure @mtunsafe lines contain at least one @mtu remark (with
# optional as, ac or asc between mt and u).
-grep -n '^@safety.*@mtunsafe' "$@" |
-grep -v '@mtunsafe{.*@mt\(asc\?\|ac\)\?u' &&
-success=false
+error_ln=$(grep -n '^@safety.*@mtunsafe' "$@" |
+grep -v '@mtunsafe{.*@mt\(asc\?\|ac\)\?u' |
+cut -d':' -f1,2)
+
+error_msg="@mtunsafe tag empty."
+check_and_set_error
# Make sure safety lines marked as @assafe do not contain any AS-Unsafe
# remark, which could be @asu or @mtasu note (with an optional c
# between as and u in both cases).
-grep -n '^@safety.*@assafe' "$@" |
-grep '@\(mt\)\?asc\?u' &&
-success=false
+error_ln=$(grep -n '^@safety.*@assafe' "$@" |
+grep '@\(mt\)\?asc\?u' |
+cut -d':' -f1,2)
+
+error_msg="@assafe tag contains AS-Unsafe remark."
+check_and_set_error
# Make sure @asunsafe lines contain at least one @asu remark (which
# could be @ascu, or @mtasu or even @mtascu).
-grep -n '^@safety.*@asunsafe' "$@" |
-grep -v '@mtasc\?u.*@asunsafe\|@asunsafe{.*@asc\?u' &&
-success=false
+error_ln=$(grep -n '^@safety.*@asunsafe' "$@" |
+grep -v '@mtasc\?u.*@asunsafe\|@asunsafe{.*@asc\?u' |
+cut -d':' -f1,2)
+
+error_msg="@asunsafe tag empty."
+check_and_set_error
# Make sure safety lines marked as @acsafe do not contain any
# AC-Unsafe remark, which could be @acu, @ascu or even @mtacu or
# @mtascu.
-grep -n '^@safety.*@acsafe' "$@" |
-grep '@\(mt\)\?as\?cu' &&
-success=false
+error_ln=$(grep -n '^@safety.*@acsafe' "$@" |
+grep '@\(mt\)\?as\?cu' |
+cut -d':' -f1,2)
+
+error_msg="@acsafe tag contains AC-Unsafe remark."
+check_and_set_error
# Make sure @acunsafe lines contain at least one @acu remark (possibly
# implied by @ascu, @mtacu or @mtascu).
-grep -n '^@safety.*@acunsafe' "$@" |
-grep -v '@\(mtas\?\|as\)cu.*@acunsafe\|@acunsafe{.*@acu' &&
-success=false
+error_ln=$(grep -n '^@safety.*@acunsafe' "$@" |
+grep -v '@\(mtas\?\|as\)cu.*@acunsafe\|@acunsafe{.*@acu' |
+cut -d':' -f1,2)
+
+error_msg="@acunsafe tag empty."
+check_and_set_error
# Make sure there aren't duplicate remarks in the same safety note.
-grep -n '^@safety' "$@" |
-grep '[^:]\(@\(mt\|a[sc]\)[^ {]*{[^ ]*}\).*[^:]\1' &&
-success=false
+error_ln=$(grep -n '^@safety' "$@" |
+grep '[^:]\(@\(mt\|a[sc]\)[^ {]*{[^ ]*}\).*[^:]\1' |
+cut -d':' -f1,2)
+
+error_msg="duplicated remark."
+check_and_set_error
# Check that comments containing safety remarks do not contain {}s,
# that all @mt remarks appear before @as remarks, that in turn appear
# before @ac remarks, all properly blank-separated, and that an
# optional comment about exclusions is between []s at the end of the
# line.
-grep -n '^@c \+[^@ ]\+\( dup\)\?'\
+error_ln=$(grep -n '^@c \+[^@ ]\+\( dup\)\?'\
'\( @\(mt\|a[sc]\)[^ ]*\)*\( \[.*\]\)\?$' "$@" |
grep -v ':@c *[^@{}]*\( @mt[^ {}]*\)*'\
-'\( @as[^ {}]*\)*\( @ac[^ {}]*\)*\( \[.*\]\)\?$' &&
-success=false
+'\( @as[^ {}]*\)*\( @ac[^ {}]*\)*\( \[.*\]\)\?$' |
+cut -d':' -f1,2)
+
+error_msg="safety remark in wrong order (@mt, @as, @ac), no space "\
+"between remarks or bad format for optional comment."
+check_and_set_error
# Check that comments containing safety remarks do not contain
# duplicate remarks.
-grep -n '^@c \+[^@ ]\+\( dup\)\?'\
+error_ln=$(grep -n '^@c \+[^@ ]\+\( dup\)\?'\
'\( @\(mt\|a[sc]\)[^ ]*\)*\( \[.*\]\)\?$' "$@" |
-grep '[^:]\(@\(mt\|a[sc]\)[^ ]*\) \(.*[^:]\)\?\1\($\| \)' &&
-success=false
+grep '[^:]\(@\(mt\|a[sc]\)[^ ]*\) \(.*[^:]\)\?\1\($\| \)' |
+cut -d':' -f1,2)
+
+error_msg="duplicated remark in a comment."
+check_and_set_error
$success
diff --git a/manual/chk-typefun.awk b/manual/chk-typefun.awk
new file mode 100644
index 0000000..9d17078
--- /dev/null
+++ b/manual/chk-typefun.awk
@@ -0,0 +1,46 @@
+#! /usr/local/bin/gawk -f
+
+# Copyright 2016 Free Software Foundation, Inc.
+# This file is part of the GNU C Library.
+
+# The GNU C Library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+
+# The GNU C Library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+
+# You should have received a copy of the GNU Lesser General Public
+# License along with the GNU C Library; if not, see
+# <http://www.gnu.org/licenses/>.
+
+
+# Checks that every @deftypefun is follown by a @safety tag.
+# Displays an error in case it is not found.
+
+
+/^@deftypefun / {
+ # Found deftypefun
+
+ # Read next line. If they are comments, keep going.
+ getline inp
+ while (match (inp, "^@c(omment)? ") ||
+ match (inp, "^@deftypefunx ") ||
+ match (inp, "^@[cp]index ")) {
+
+ getline inp
+ }
+
+ # Done reading comments, it's a @safety tag or
+ # we have to report error.
+ if (!match (inp, "^@safety{")) {
+ printf "%s:%d\n", FILENAME, FNR
+ exit 1
+ }
+
+ # If we get here is because tags were correctly
+ # placed.
+}
diff --git a/manual/errno.texi b/manual/errno.texi
index 1068be3..b14db62 100644
--- a/manual/errno.texi
+++ b/manual/errno.texi
@@ -1335,7 +1335,7 @@ This function @code{strerror_r} is a GNU extension and it is declared in
@comment stdio.h
@comment ISO
@deftypefun void perror (const char *@var{message})
-@safety{@prelim{}@mtsafe{@mtasurace{:stderr}}@asunsafe{@asucorrupt{} @ascuintl{} @ascuheap{} @asulock{}}@acunsafe{@acucorrupt{} @aculock{} @acsmem{} @acsfd{}}}
+@safety{@prelim{}@mtunsafe{@mtasurace{:stderr}}@asunsafe{@asucorrupt{} @ascuintl{} @ascuheap{} @asulock{}}@acunsafe{@acucorrupt{} @aculock{} @acsmem{} @acsfd{}}}
@c Besides strerror_r's and some of fprintf's issues, if stderr is not
@c oriented yet, create a new stream with a dup of stderr's fd and write
@c to that instead of stderr, to avoid orienting it.
diff --git a/manual/install.texi b/manual/install.texi
index de9d270..1e8d323 100644
--- a/manual/install.texi
+++ b/manual/install.texi
@@ -266,7 +266,8 @@ To format the @cite{GNU C Library Reference Manual} for printing, type
@w{@code{make dvi}}. You need a working @TeX{} installation to do
this. The distribution builds the on-line formatted version of the
manual, as Info files, as part of the build process. You can build
-them manually with @w{@code{make info}}.
+them manually with @w{@code{make info}}. Moreover, it's possible
+to get a copy in PDF format. To build it, type @w{@code{make pdf}}.
The library has a number of special-purpose configuration parameters
which you can find in @file{Makeconfig}. These can be overwritten with
--
2.5.0
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [PATCH v2] Improve debugging for manual safety annotations
2015-10-05 10:10 ` Juan Manuel Torres Palma
@ 2015-10-05 11:23 ` Joseph Myers
0 siblings, 0 replies; 9+ messages in thread
From: Joseph Myers @ 2015-10-05 11:23 UTC (permalink / raw)
To: Juan Manuel Torres Palma; +Cc: libc-alpha
I'd suggest that when pinging you might want to CC experts on the relevant
code (Alexandre Oliva in the case of anything related to safety
annotations).
--
Joseph S. Myers
joseph@codesourcery.com
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [PATCH v2] Improve debugging for manual safety annotations
2015-09-03 22:28 ` Juan Manuel Torres Palma
@ 2015-10-05 10:10 ` Juan Manuel Torres Palma
2015-10-05 11:23 ` Joseph Myers
0 siblings, 1 reply; 9+ messages in thread
From: Juan Manuel Torres Palma @ 2015-10-05 10:10 UTC (permalink / raw)
To: libc-alpha
Ping^2
2015-09-04 0:28 GMT+02:00 Juan Manuel Torres Palma <j.m.torrespalma@gmail.com>:
> Ping.
>
> 2015-08-31 20:56 GMT+09:00 Juan Manuel Torres Palma <j.m.torrespalma@gmail.com>:
>> From: Juan Manuel Torres Palma <jmtorrespalma@gmail.com>
>>
>> This patch improves previous safety tags checking script
>> and adds more output in case of errors. Also fixes a couple
>> bugs in the manual building system and adds a new file to
>> check that @deftypefun tags are always follown by @safety.
>>
>> 2015-08-31 Juan Manuel Torres Palma <j.m.torrespalma@gmail.com>
>>
>> * INSTALL: Regenerated.
>> * manual/check-safety.sh: Fix bugs when finding AS-Unsafe tags
>> and add new debugging layer for this script.
>> * manual/chk-typefun.awk: New file. Searches for @deftypefun
>> that aren't paired with @safety annotations.
>> * manual/errno.texi (perror): Fix wrong tag.
>> * manual/install.texi: Add reference to 'make pdf'.
>>
>> diff --git a/INSTALL b/INSTALL
>> index d55de5d..a35c297 100644
>> --- a/INSTALL
>> +++ b/INSTALL
>> @@ -223,7 +223,8 @@ failure occurs.
>> 'make dvi'. You need a working TeX installation to do this. The
>> distribution builds the on-line formatted version of the manual, as Info
>> files, as part of the build process. You can build them manually with
>> -'make info'.
>> +'make info'. Moreover, it's possible to get a copy in PDF format. To
>> +build it, type 'make pdf'.
>>
>> The library has a number of special-purpose configuration parameters
>> which you can find in 'Makeconfig'. These can be overwritten with the
>> diff --git a/manual/check-safety.sh b/manual/check-safety.sh
>> index d7c2ca5..9ca50cc 100644
>> --- a/manual/check-safety.sh
>> +++ b/manual/check-safety.sh
>> @@ -24,23 +24,48 @@
>> # an explicit reason and when there's a reason for unsafety it's not
>> # safe, and that there aren't duplicates remarks.
>>
>> -
>> +# Set to ":" if no error was found, and to "false" if found.
>> success=:
>>
>> +# Gets the name of the file and line where an error was found.
>> +error_ln=
>> +
>> +# Holds the error message for an error.
>> +error_msg=
>> +
>> # 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).
>> +
>> +# Function to check errors and set $success.
>> +check_and_set_error ()
>> +{
>> + if [ -n "$error_ln" ]
>> + then
>> + echo "$error_ln:Error $error_msg"
>> + success=false
>> + fi
>> +}
>> +
>> +
>> +# Check that each @deftypefu?n is followed by a @safety note,
>> +# with nothing but @deftypefu?nx and comment lines in between.
>> +# Also indexes are allowed.
>> +error_ln=$(awk -f chk-typefun.awk "$@")
>> +error_msg="unexpected tag between @deftypefun and @safety."
>> +check_and_set_error
>>
>>
>> # 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' "$@" |
>> +error_ln=$(grep -n '^@safety' "$@" |
>> grep -v ':@safety{\(@prelim{}\)\?@mt\(un\)\?safe{.*}'\
>> -'@as\(un\)\?safe{.*}@ac\(un\)\?safe{.*}}' &&
>> -success=false
>> +'@as\(un\)\?safe{.*}@ac\(un\)\?safe{.*}}' |
>> +cut -d':' -f1,2)
>> +
>> +error_msg="safety marks are in incorrect order (MT, AS, AC)."
>> +check_and_set_error
>> +
>>
>> # Check that @mt-started notes appear within @mtsafe or @mtunsafe,
>> # that @as-started notes appear within @assafe or @asunsafe, and that
>> @@ -49,76 +74,108 @@ success=false
>> # unsafe), but let @mt have as, ac or asc before [su], and let @as
>> # have a c (for cancel) before [su]. Also make sure blanks separate
>> # each of the annotations.
>> -grep -n '^@safety' "$@" |
>> +error_ln=$(grep -n '^@safety' "$@" |
>> grep -v ':@safety{\(@prelim{}\)\?'\
>> '@mt\(un\)\?safe{\(@mt\(asc\?\|ac\)\?[su][^ ]*}\)\?'\
>> '\( @mt\(asc\?\|ac\)\?[su][^ ]*}\)*}'\
>> '@as\(un\)\?safe{\(@asc\?[su][^ ]*}\)\?'\
>> '\( @asc\?[su][^ ]*}\)*}'\
>> '@ac\(un\)\?safe{\(@ac[su][^ ]*}\)\?'\
>> -'\( @ac[su][^ ]*}\)*}}' &&
>> -success=false
>> +'\( @ac[su][^ ]*}\)*}}' |
>> +cut -d':' -f1,2)
>> +
>> +error_msg="tags are uncorrectly set. Check that every "\
>> +"remark is placed in the right tag."
>> +check_and_set_error
>>
>> # Make sure safety lines marked as @mtsafe do not contain any
>> # MT-Unsafe remark; that would be @mtu, but there could be as, ac or
>> # asc between mt and u.
>> -grep -n '^@safety.*@mtsafe' "$@" |
>> -grep '@mt\(asc\?\|ac\)?u' "$@" &&
>> -success=false
>> +error_ln=$(grep -n '^@safety.*@mtsafe' "$@" |
>> +grep '@mt\(asc\?\|ac\)\?u' |
>> +cut -d':' -f1,2)
>> +
>> +error_msg="@mtsafe tag contains MT-Unsafe remark."
>> +check_and_set_error
>>
>> # Make sure @mtunsafe lines contain at least one @mtu remark (with
>> # optional as, ac or asc between mt and u).
>> -grep -n '^@safety.*@mtunsafe' "$@" |
>> -grep -v '@mtunsafe{.*@mt\(asc\?\|ac\)\?u' &&
>> -success=false
>> +error_ln=$(grep -n '^@safety.*@mtunsafe' "$@" |
>> +grep -v '@mtunsafe{.*@mt\(asc\?\|ac\)\?u' |
>> +cut -d':' -f1,2)
>> +
>> +error_msg="@mtunsafe tag empty."
>> +check_and_set_error
>>
>> # Make sure safety lines marked as @assafe do not contain any AS-Unsafe
>> # remark, which could be @asu or @mtasu note (with an optional c
>> # between as and u in both cases).
>> -grep -n '^@safety.*@assafe' "$@" |
>> -grep '@\(mt\)\?asc\?u' &&
>> -success=false
>> +error_ln=$(grep -n '^@safety.*@assafe' "$@" |
>> +grep '@\(mt\)\?asc\?u' |
>> +cut -d':' -f1,2)
>> +
>> +error_msg="@assafe tag contains AS-Unsafe remark."
>> +check_and_set_error
>>
>> # Make sure @asunsafe lines contain at least one @asu remark (which
>> # could be @ascu, or @mtasu or even @mtascu).
>> -grep -n '^@safety.*@asunsafe' "$@" |
>> -grep -v '@mtasc\?u.*@asunsafe\|@asunsafe{.*@asc\?u' &&
>> -success=false
>> +error_ln=$(grep -n '^@safety.*@asunsafe' "$@" |
>> +grep -v '@mtasc\?u.*@asunsafe\|@asunsafe{.*@asc\?u' |
>> +cut -d':' -f1,2)
>> +
>> +error_msg="@asunsafe tag empty."
>> +check_and_set_error
>>
>> # Make sure safety lines marked as @acsafe do not contain any
>> # AC-Unsafe remark, which could be @acu, @ascu or even @mtacu or
>> # @mtascu.
>> -grep -n '^@safety.*@acsafe' "$@" |
>> -grep '@\(mt\)\?as\?cu' &&
>> -success=false
>> +error_ln=$(grep -n '^@safety.*@acsafe' "$@" |
>> +grep '@\(mt\)\?as\?cu' |
>> +cut -d':' -f1,2)
>> +
>> +error_msg="@acsafe tag contains AC-Unsafe remark."
>> +check_and_set_error
>>
>> # Make sure @acunsafe lines contain at least one @acu remark (possibly
>> # implied by @ascu, @mtacu or @mtascu).
>> -grep -n '^@safety.*@acunsafe' "$@" |
>> -grep -v '@\(mtas\?\|as\)cu.*@acunsafe\|@acunsafe{.*@acu' &&
>> -success=false
>> +error_ln=$(grep -n '^@safety.*@acunsafe' "$@" |
>> +grep -v '@\(mtas\?\|as\)cu.*@acunsafe\|@acunsafe{.*@acu' |
>> +cut -d':' -f1,2)
>> +
>> +error_msg="@acunsafe tag empty."
>> +check_and_set_error
>>
>> # Make sure there aren't duplicate remarks in the same safety note.
>> -grep -n '^@safety' "$@" |
>> -grep '[^:]\(@\(mt\|a[sc]\)[^ {]*{[^ ]*}\).*[^:]\1' &&
>> -success=false
>> +error_ln=$(grep -n '^@safety' "$@" |
>> +grep '[^:]\(@\(mt\|a[sc]\)[^ {]*{[^ ]*}\).*[^:]\1' |
>> +cut -d':' -f1,2)
>> +
>> +error_msg="duplicated remark."
>> +check_and_set_error
>>
>> # Check that comments containing safety remarks do not contain {}s,
>> # that all @mt remarks appear before @as remarks, that in turn appear
>> # before @ac remarks, all properly blank-separated, and that an
>> # optional comment about exclusions is between []s at the end of the
>> # line.
>> -grep -n '^@c \+[^@ ]\+\( dup\)\?'\
>> +error_ln=$(grep -n '^@c \+[^@ ]\+\( dup\)\?'\
>> '\( @\(mt\|a[sc]\)[^ ]*\)*\( \[.*\]\)\?$' "$@" |
>> grep -v ':@c *[^@{}]*\( @mt[^ {}]*\)*'\
>> -'\( @as[^ {}]*\)*\( @ac[^ {}]*\)*\( \[.*\]\)\?$' &&
>> -success=false
>> +'\( @as[^ {}]*\)*\( @ac[^ {}]*\)*\( \[.*\]\)\?$' |
>> +cut -d':' -f1,2)
>> +
>> +error_msg="safety remark in wrong order (@mt, @as, @ac), no space "\
>> +"between remarks or bad format for optional comment."
>> +check_and_set_error
>>
>> # Check that comments containing safety remarks do not contain
>> # duplicate remarks.
>> -grep -n '^@c \+[^@ ]\+\( dup\)\?'\
>> +error_ln=$(grep -n '^@c \+[^@ ]\+\( dup\)\?'\
>> '\( @\(mt\|a[sc]\)[^ ]*\)*\( \[.*\]\)\?$' "$@" |
>> -grep '[^:]\(@\(mt\|a[sc]\)[^ ]*\) \(.*[^:]\)\?\1\($\| \)' &&
>> -success=false
>> +grep '[^:]\(@\(mt\|a[sc]\)[^ ]*\) \(.*[^:]\)\?\1\($\| \)' |
>> +cut -d':' -f1,2)
>> +
>> +error_msg="duplicated remark in a comment."
>> +check_and_set_error
>>
>> $success
>> diff --git a/manual/chk-typefun.awk b/manual/chk-typefun.awk
>> new file mode 100644
>> index 0000000..10a0ca4
>> --- /dev/null
>> +++ b/manual/chk-typefun.awk
>> @@ -0,0 +1,46 @@
>> +#! /usr/local/bin/gawk -f
>> +
>> +# Copyright 2015 Free Software Foundation, Inc.
>> +# This file is part of the GNU C Library.
>> +
>> +# The GNU C Library is free software; you can redistribute it and/or
>> +# modify it under the terms of the GNU Lesser General Public
>> +# License as published by the Free Software Foundation; either
>> +# version 2.1 of the License, or (at your option) any later version.
>> +
>> +# The GNU C Library is distributed in the hope that it will be useful,
>> +# but WITHOUT ANY WARRANTY; without even the implied warranty of
>> +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
>> +# Lesser General Public License for more details.
>> +
>> +# You should have received a copy of the GNU Lesser General Public
>> +# License along with the GNU C Library; if not, see
>> +# <http://www.gnu.org/licenses/>.
>> +
>> +
>> +# Checks that every @deftypefun is follown by a @safety tag.
>> +# Displays an error in case it is not found.
>> +
>> +
>> +/^@deftypefun / {
>> + # Found deftypefun
>> +
>> + # Read next line. If they are comments, keep going.
>> + getline inp
>> + while (match (inp, "^@c(omment)? ") ||
>> + match (inp, "^@deftypefunx ") ||
>> + match (inp, "^@[cp]index ")) {
>> +
>> + getline inp
>> + }
>> +
>> + # Done reading comments, it's a @safety tag or
>> + # we have to report error.
>> + if (!match (inp, "^@safety{")) {
>> + printf "%s:%d\n", FILENAME, FNR
>> + exit 1
>> + }
>> +
>> + # If we get here is because tags were correctly
>> + # placed.
>> +}
>> diff --git a/manual/errno.texi b/manual/errno.texi
>> index 1068be3..b14db62 100644
>> --- a/manual/errno.texi
>> +++ b/manual/errno.texi
>> @@ -1335,7 +1335,7 @@ This function @code{strerror_r} is a GNU extension and it is declared in
>> @comment stdio.h
>> @comment ISO
>> @deftypefun void perror (const char *@var{message})
>> -@safety{@prelim{}@mtsafe{@mtasurace{:stderr}}@asunsafe{@asucorrupt{} @ascuintl{} @ascuheap{} @asulock{}}@acunsafe{@acucorrupt{} @aculock{} @acsmem{} @acsfd{}}}
>> +@safety{@prelim{}@mtunsafe{@mtasurace{:stderr}}@asunsafe{@asucorrupt{} @ascuintl{} @ascuheap{} @asulock{}}@acunsafe{@acucorrupt{} @aculock{} @acsmem{} @acsfd{}}}
>> @c Besides strerror_r's and some of fprintf's issues, if stderr is not
>> @c oriented yet, create a new stream with a dup of stderr's fd and write
>> @c to that instead of stderr, to avoid orienting it.
>> diff --git a/manual/install.texi b/manual/install.texi
>> index 63c41b0..1ebcca5 100644
>> --- a/manual/install.texi
>> +++ b/manual/install.texi
>> @@ -256,7 +256,8 @@ To format the @cite{GNU C Library Reference Manual} for printing, type
>> @w{@code{make dvi}}. You need a working @TeX{} installation to do
>> this. The distribution builds the on-line formatted version of the
>> manual, as Info files, as part of the build process. You can build
>> -them manually with @w{@code{make info}}.
>> +them manually with @w{@code{make info}}. Moreover, it's possible
>> +to get a copy in PDF format. To build it, type @w{@code{make pdf}}.
>>
>> The library has a number of special-purpose configuration parameters
>> which you can find in @file{Makeconfig}. These can be overwritten with
>> --
>> 2.1.0
>>
>
>
>
> --
> Juan Manuel Torres Palma.
> Computer Science Student at Universidad de Granada.
--
Juan Manuel Torres Palma.
Computer Science Student at Universidad de Granada.
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [PATCH v2] Improve debugging for manual safety annotations
2015-08-31 11:57 Juan Manuel Torres Palma
@ 2015-09-03 22:28 ` Juan Manuel Torres Palma
2015-10-05 10:10 ` Juan Manuel Torres Palma
0 siblings, 1 reply; 9+ messages in thread
From: Juan Manuel Torres Palma @ 2015-09-03 22:28 UTC (permalink / raw)
To: libc-alpha
Ping.
2015-08-31 20:56 GMT+09:00 Juan Manuel Torres Palma <j.m.torrespalma@gmail.com>:
> From: Juan Manuel Torres Palma <jmtorrespalma@gmail.com>
>
> This patch improves previous safety tags checking script
> and adds more output in case of errors. Also fixes a couple
> bugs in the manual building system and adds a new file to
> check that @deftypefun tags are always follown by @safety.
>
> 2015-08-31 Juan Manuel Torres Palma <j.m.torrespalma@gmail.com>
>
> * INSTALL: Regenerated.
> * manual/check-safety.sh: Fix bugs when finding AS-Unsafe tags
> and add new debugging layer for this script.
> * manual/chk-typefun.awk: New file. Searches for @deftypefun
> that aren't paired with @safety annotations.
> * manual/errno.texi (perror): Fix wrong tag.
> * manual/install.texi: Add reference to 'make pdf'.
>
> diff --git a/INSTALL b/INSTALL
> index d55de5d..a35c297 100644
> --- a/INSTALL
> +++ b/INSTALL
> @@ -223,7 +223,8 @@ failure occurs.
> 'make dvi'. You need a working TeX installation to do this. The
> distribution builds the on-line formatted version of the manual, as Info
> files, as part of the build process. You can build them manually with
> -'make info'.
> +'make info'. Moreover, it's possible to get a copy in PDF format. To
> +build it, type 'make pdf'.
>
> The library has a number of special-purpose configuration parameters
> which you can find in 'Makeconfig'. These can be overwritten with the
> diff --git a/manual/check-safety.sh b/manual/check-safety.sh
> index d7c2ca5..9ca50cc 100644
> --- a/manual/check-safety.sh
> +++ b/manual/check-safety.sh
> @@ -24,23 +24,48 @@
> # an explicit reason and when there's a reason for unsafety it's not
> # safe, and that there aren't duplicates remarks.
>
> -
> +# Set to ":" if no error was found, and to "false" if found.
> success=:
>
> +# Gets the name of the file and line where an error was found.
> +error_ln=
> +
> +# Holds the error message for an error.
> +error_msg=
> +
> # 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).
> +
> +# Function to check errors and set $success.
> +check_and_set_error ()
> +{
> + if [ -n "$error_ln" ]
> + then
> + echo "$error_ln:Error $error_msg"
> + success=false
> + fi
> +}
> +
> +
> +# Check that each @deftypefu?n is followed by a @safety note,
> +# with nothing but @deftypefu?nx and comment lines in between.
> +# Also indexes are allowed.
> +error_ln=$(awk -f chk-typefun.awk "$@")
> +error_msg="unexpected tag between @deftypefun and @safety."
> +check_and_set_error
>
>
> # 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' "$@" |
> +error_ln=$(grep -n '^@safety' "$@" |
> grep -v ':@safety{\(@prelim{}\)\?@mt\(un\)\?safe{.*}'\
> -'@as\(un\)\?safe{.*}@ac\(un\)\?safe{.*}}' &&
> -success=false
> +'@as\(un\)\?safe{.*}@ac\(un\)\?safe{.*}}' |
> +cut -d':' -f1,2)
> +
> +error_msg="safety marks are in incorrect order (MT, AS, AC)."
> +check_and_set_error
> +
>
> # Check that @mt-started notes appear within @mtsafe or @mtunsafe,
> # that @as-started notes appear within @assafe or @asunsafe, and that
> @@ -49,76 +74,108 @@ success=false
> # unsafe), but let @mt have as, ac or asc before [su], and let @as
> # have a c (for cancel) before [su]. Also make sure blanks separate
> # each of the annotations.
> -grep -n '^@safety' "$@" |
> +error_ln=$(grep -n '^@safety' "$@" |
> grep -v ':@safety{\(@prelim{}\)\?'\
> '@mt\(un\)\?safe{\(@mt\(asc\?\|ac\)\?[su][^ ]*}\)\?'\
> '\( @mt\(asc\?\|ac\)\?[su][^ ]*}\)*}'\
> '@as\(un\)\?safe{\(@asc\?[su][^ ]*}\)\?'\
> '\( @asc\?[su][^ ]*}\)*}'\
> '@ac\(un\)\?safe{\(@ac[su][^ ]*}\)\?'\
> -'\( @ac[su][^ ]*}\)*}}' &&
> -success=false
> +'\( @ac[su][^ ]*}\)*}}' |
> +cut -d':' -f1,2)
> +
> +error_msg="tags are uncorrectly set. Check that every "\
> +"remark is placed in the right tag."
> +check_and_set_error
>
> # Make sure safety lines marked as @mtsafe do not contain any
> # MT-Unsafe remark; that would be @mtu, but there could be as, ac or
> # asc between mt and u.
> -grep -n '^@safety.*@mtsafe' "$@" |
> -grep '@mt\(asc\?\|ac\)?u' "$@" &&
> -success=false
> +error_ln=$(grep -n '^@safety.*@mtsafe' "$@" |
> +grep '@mt\(asc\?\|ac\)\?u' |
> +cut -d':' -f1,2)
> +
> +error_msg="@mtsafe tag contains MT-Unsafe remark."
> +check_and_set_error
>
> # Make sure @mtunsafe lines contain at least one @mtu remark (with
> # optional as, ac or asc between mt and u).
> -grep -n '^@safety.*@mtunsafe' "$@" |
> -grep -v '@mtunsafe{.*@mt\(asc\?\|ac\)\?u' &&
> -success=false
> +error_ln=$(grep -n '^@safety.*@mtunsafe' "$@" |
> +grep -v '@mtunsafe{.*@mt\(asc\?\|ac\)\?u' |
> +cut -d':' -f1,2)
> +
> +error_msg="@mtunsafe tag empty."
> +check_and_set_error
>
> # Make sure safety lines marked as @assafe do not contain any AS-Unsafe
> # remark, which could be @asu or @mtasu note (with an optional c
> # between as and u in both cases).
> -grep -n '^@safety.*@assafe' "$@" |
> -grep '@\(mt\)\?asc\?u' &&
> -success=false
> +error_ln=$(grep -n '^@safety.*@assafe' "$@" |
> +grep '@\(mt\)\?asc\?u' |
> +cut -d':' -f1,2)
> +
> +error_msg="@assafe tag contains AS-Unsafe remark."
> +check_and_set_error
>
> # Make sure @asunsafe lines contain at least one @asu remark (which
> # could be @ascu, or @mtasu or even @mtascu).
> -grep -n '^@safety.*@asunsafe' "$@" |
> -grep -v '@mtasc\?u.*@asunsafe\|@asunsafe{.*@asc\?u' &&
> -success=false
> +error_ln=$(grep -n '^@safety.*@asunsafe' "$@" |
> +grep -v '@mtasc\?u.*@asunsafe\|@asunsafe{.*@asc\?u' |
> +cut -d':' -f1,2)
> +
> +error_msg="@asunsafe tag empty."
> +check_and_set_error
>
> # Make sure safety lines marked as @acsafe do not contain any
> # AC-Unsafe remark, which could be @acu, @ascu or even @mtacu or
> # @mtascu.
> -grep -n '^@safety.*@acsafe' "$@" |
> -grep '@\(mt\)\?as\?cu' &&
> -success=false
> +error_ln=$(grep -n '^@safety.*@acsafe' "$@" |
> +grep '@\(mt\)\?as\?cu' |
> +cut -d':' -f1,2)
> +
> +error_msg="@acsafe tag contains AC-Unsafe remark."
> +check_and_set_error
>
> # Make sure @acunsafe lines contain at least one @acu remark (possibly
> # implied by @ascu, @mtacu or @mtascu).
> -grep -n '^@safety.*@acunsafe' "$@" |
> -grep -v '@\(mtas\?\|as\)cu.*@acunsafe\|@acunsafe{.*@acu' &&
> -success=false
> +error_ln=$(grep -n '^@safety.*@acunsafe' "$@" |
> +grep -v '@\(mtas\?\|as\)cu.*@acunsafe\|@acunsafe{.*@acu' |
> +cut -d':' -f1,2)
> +
> +error_msg="@acunsafe tag empty."
> +check_and_set_error
>
> # Make sure there aren't duplicate remarks in the same safety note.
> -grep -n '^@safety' "$@" |
> -grep '[^:]\(@\(mt\|a[sc]\)[^ {]*{[^ ]*}\).*[^:]\1' &&
> -success=false
> +error_ln=$(grep -n '^@safety' "$@" |
> +grep '[^:]\(@\(mt\|a[sc]\)[^ {]*{[^ ]*}\).*[^:]\1' |
> +cut -d':' -f1,2)
> +
> +error_msg="duplicated remark."
> +check_and_set_error
>
> # Check that comments containing safety remarks do not contain {}s,
> # that all @mt remarks appear before @as remarks, that in turn appear
> # before @ac remarks, all properly blank-separated, and that an
> # optional comment about exclusions is between []s at the end of the
> # line.
> -grep -n '^@c \+[^@ ]\+\( dup\)\?'\
> +error_ln=$(grep -n '^@c \+[^@ ]\+\( dup\)\?'\
> '\( @\(mt\|a[sc]\)[^ ]*\)*\( \[.*\]\)\?$' "$@" |
> grep -v ':@c *[^@{}]*\( @mt[^ {}]*\)*'\
> -'\( @as[^ {}]*\)*\( @ac[^ {}]*\)*\( \[.*\]\)\?$' &&
> -success=false
> +'\( @as[^ {}]*\)*\( @ac[^ {}]*\)*\( \[.*\]\)\?$' |
> +cut -d':' -f1,2)
> +
> +error_msg="safety remark in wrong order (@mt, @as, @ac), no space "\
> +"between remarks or bad format for optional comment."
> +check_and_set_error
>
> # Check that comments containing safety remarks do not contain
> # duplicate remarks.
> -grep -n '^@c \+[^@ ]\+\( dup\)\?'\
> +error_ln=$(grep -n '^@c \+[^@ ]\+\( dup\)\?'\
> '\( @\(mt\|a[sc]\)[^ ]*\)*\( \[.*\]\)\?$' "$@" |
> -grep '[^:]\(@\(mt\|a[sc]\)[^ ]*\) \(.*[^:]\)\?\1\($\| \)' &&
> -success=false
> +grep '[^:]\(@\(mt\|a[sc]\)[^ ]*\) \(.*[^:]\)\?\1\($\| \)' |
> +cut -d':' -f1,2)
> +
> +error_msg="duplicated remark in a comment."
> +check_and_set_error
>
> $success
> diff --git a/manual/chk-typefun.awk b/manual/chk-typefun.awk
> new file mode 100644
> index 0000000..10a0ca4
> --- /dev/null
> +++ b/manual/chk-typefun.awk
> @@ -0,0 +1,46 @@
> +#! /usr/local/bin/gawk -f
> +
> +# Copyright 2015 Free Software Foundation, Inc.
> +# This file is part of the GNU C Library.
> +
> +# The GNU C Library is free software; you can redistribute it and/or
> +# modify it under the terms of the GNU Lesser General Public
> +# License as published by the Free Software Foundation; either
> +# version 2.1 of the License, or (at your option) any later version.
> +
> +# The GNU C Library is distributed in the hope that it will be useful,
> +# but WITHOUT ANY WARRANTY; without even the implied warranty of
> +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
> +# Lesser General Public License for more details.
> +
> +# You should have received a copy of the GNU Lesser General Public
> +# License along with the GNU C Library; if not, see
> +# <http://www.gnu.org/licenses/>.
> +
> +
> +# Checks that every @deftypefun is follown by a @safety tag.
> +# Displays an error in case it is not found.
> +
> +
> +/^@deftypefun / {
> + # Found deftypefun
> +
> + # Read next line. If they are comments, keep going.
> + getline inp
> + while (match (inp, "^@c(omment)? ") ||
> + match (inp, "^@deftypefunx ") ||
> + match (inp, "^@[cp]index ")) {
> +
> + getline inp
> + }
> +
> + # Done reading comments, it's a @safety tag or
> + # we have to report error.
> + if (!match (inp, "^@safety{")) {
> + printf "%s:%d\n", FILENAME, FNR
> + exit 1
> + }
> +
> + # If we get here is because tags were correctly
> + # placed.
> +}
> diff --git a/manual/errno.texi b/manual/errno.texi
> index 1068be3..b14db62 100644
> --- a/manual/errno.texi
> +++ b/manual/errno.texi
> @@ -1335,7 +1335,7 @@ This function @code{strerror_r} is a GNU extension and it is declared in
> @comment stdio.h
> @comment ISO
> @deftypefun void perror (const char *@var{message})
> -@safety{@prelim{}@mtsafe{@mtasurace{:stderr}}@asunsafe{@asucorrupt{} @ascuintl{} @ascuheap{} @asulock{}}@acunsafe{@acucorrupt{} @aculock{} @acsmem{} @acsfd{}}}
> +@safety{@prelim{}@mtunsafe{@mtasurace{:stderr}}@asunsafe{@asucorrupt{} @ascuintl{} @ascuheap{} @asulock{}}@acunsafe{@acucorrupt{} @aculock{} @acsmem{} @acsfd{}}}
> @c Besides strerror_r's and some of fprintf's issues, if stderr is not
> @c oriented yet, create a new stream with a dup of stderr's fd and write
> @c to that instead of stderr, to avoid orienting it.
> diff --git a/manual/install.texi b/manual/install.texi
> index 63c41b0..1ebcca5 100644
> --- a/manual/install.texi
> +++ b/manual/install.texi
> @@ -256,7 +256,8 @@ To format the @cite{GNU C Library Reference Manual} for printing, type
> @w{@code{make dvi}}. You need a working @TeX{} installation to do
> this. The distribution builds the on-line formatted version of the
> manual, as Info files, as part of the build process. You can build
> -them manually with @w{@code{make info}}.
> +them manually with @w{@code{make info}}. Moreover, it's possible
> +to get a copy in PDF format. To build it, type @w{@code{make pdf}}.
>
> The library has a number of special-purpose configuration parameters
> which you can find in @file{Makeconfig}. These can be overwritten with
> --
> 2.1.0
>
--
Juan Manuel Torres Palma.
Computer Science Student at Universidad de Granada.
^ permalink raw reply [flat|nested] 9+ messages in thread
* [PATCH v2] Improve debugging for manual safety annotations
@ 2015-08-31 11:57 Juan Manuel Torres Palma
2015-09-03 22:28 ` Juan Manuel Torres Palma
0 siblings, 1 reply; 9+ messages in thread
From: Juan Manuel Torres Palma @ 2015-08-31 11:57 UTC (permalink / raw)
To: libc-alpha
From: Juan Manuel Torres Palma <jmtorrespalma@gmail.com>
This patch improves previous safety tags checking script
and adds more output in case of errors. Also fixes a couple
bugs in the manual building system and adds a new file to
check that @deftypefun tags are always follown by @safety.
2015-08-31 Juan Manuel Torres Palma <j.m.torrespalma@gmail.com>
* INSTALL: Regenerated.
* manual/check-safety.sh: Fix bugs when finding AS-Unsafe tags
and add new debugging layer for this script.
* manual/chk-typefun.awk: New file. Searches for @deftypefun
that aren't paired with @safety annotations.
* manual/errno.texi (perror): Fix wrong tag.
* manual/install.texi: Add reference to 'make pdf'.
diff --git a/INSTALL b/INSTALL
index d55de5d..a35c297 100644
--- a/INSTALL
+++ b/INSTALL
@@ -223,7 +223,8 @@ failure occurs.
'make dvi'. You need a working TeX installation to do this. The
distribution builds the on-line formatted version of the manual, as Info
files, as part of the build process. You can build them manually with
-'make info'.
+'make info'. Moreover, it's possible to get a copy in PDF format. To
+build it, type 'make pdf'.
The library has a number of special-purpose configuration parameters
which you can find in 'Makeconfig'. These can be overwritten with the
diff --git a/manual/check-safety.sh b/manual/check-safety.sh
index d7c2ca5..9ca50cc 100644
--- a/manual/check-safety.sh
+++ b/manual/check-safety.sh
@@ -24,23 +24,48 @@
# an explicit reason and when there's a reason for unsafety it's not
# safe, and that there aren't duplicates remarks.
-
+# Set to ":" if no error was found, and to "false" if found.
success=:
+# Gets the name of the file and line where an error was found.
+error_ln=
+
+# Holds the error message for an error.
+error_msg=
+
# 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).
+
+# Function to check errors and set $success.
+check_and_set_error ()
+{
+ if [ -n "$error_ln" ]
+ then
+ echo "$error_ln:Error $error_msg"
+ success=false
+ fi
+}
+
+
+# Check that each @deftypefu?n is followed by a @safety note,
+# with nothing but @deftypefu?nx and comment lines in between.
+# Also indexes are allowed.
+error_ln=$(awk -f chk-typefun.awk "$@")
+error_msg="unexpected tag between @deftypefun and @safety."
+check_and_set_error
# 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' "$@" |
+error_ln=$(grep -n '^@safety' "$@" |
grep -v ':@safety{\(@prelim{}\)\?@mt\(un\)\?safe{.*}'\
-'@as\(un\)\?safe{.*}@ac\(un\)\?safe{.*}}' &&
-success=false
+'@as\(un\)\?safe{.*}@ac\(un\)\?safe{.*}}' |
+cut -d':' -f1,2)
+
+error_msg="safety marks are in incorrect order (MT, AS, AC)."
+check_and_set_error
+
# Check that @mt-started notes appear within @mtsafe or @mtunsafe,
# that @as-started notes appear within @assafe or @asunsafe, and that
@@ -49,76 +74,108 @@ success=false
# unsafe), but let @mt have as, ac or asc before [su], and let @as
# have a c (for cancel) before [su]. Also make sure blanks separate
# each of the annotations.
-grep -n '^@safety' "$@" |
+error_ln=$(grep -n '^@safety' "$@" |
grep -v ':@safety{\(@prelim{}\)\?'\
'@mt\(un\)\?safe{\(@mt\(asc\?\|ac\)\?[su][^ ]*}\)\?'\
'\( @mt\(asc\?\|ac\)\?[su][^ ]*}\)*}'\
'@as\(un\)\?safe{\(@asc\?[su][^ ]*}\)\?'\
'\( @asc\?[su][^ ]*}\)*}'\
'@ac\(un\)\?safe{\(@ac[su][^ ]*}\)\?'\
-'\( @ac[su][^ ]*}\)*}}' &&
-success=false
+'\( @ac[su][^ ]*}\)*}}' |
+cut -d':' -f1,2)
+
+error_msg="tags are uncorrectly set. Check that every "\
+"remark is placed in the right tag."
+check_and_set_error
# Make sure safety lines marked as @mtsafe do not contain any
# MT-Unsafe remark; that would be @mtu, but there could be as, ac or
# asc between mt and u.
-grep -n '^@safety.*@mtsafe' "$@" |
-grep '@mt\(asc\?\|ac\)?u' "$@" &&
-success=false
+error_ln=$(grep -n '^@safety.*@mtsafe' "$@" |
+grep '@mt\(asc\?\|ac\)\?u' |
+cut -d':' -f1,2)
+
+error_msg="@mtsafe tag contains MT-Unsafe remark."
+check_and_set_error
# Make sure @mtunsafe lines contain at least one @mtu remark (with
# optional as, ac or asc between mt and u).
-grep -n '^@safety.*@mtunsafe' "$@" |
-grep -v '@mtunsafe{.*@mt\(asc\?\|ac\)\?u' &&
-success=false
+error_ln=$(grep -n '^@safety.*@mtunsafe' "$@" |
+grep -v '@mtunsafe{.*@mt\(asc\?\|ac\)\?u' |
+cut -d':' -f1,2)
+
+error_msg="@mtunsafe tag empty."
+check_and_set_error
# Make sure safety lines marked as @assafe do not contain any AS-Unsafe
# remark, which could be @asu or @mtasu note (with an optional c
# between as and u in both cases).
-grep -n '^@safety.*@assafe' "$@" |
-grep '@\(mt\)\?asc\?u' &&
-success=false
+error_ln=$(grep -n '^@safety.*@assafe' "$@" |
+grep '@\(mt\)\?asc\?u' |
+cut -d':' -f1,2)
+
+error_msg="@assafe tag contains AS-Unsafe remark."
+check_and_set_error
# Make sure @asunsafe lines contain at least one @asu remark (which
# could be @ascu, or @mtasu or even @mtascu).
-grep -n '^@safety.*@asunsafe' "$@" |
-grep -v '@mtasc\?u.*@asunsafe\|@asunsafe{.*@asc\?u' &&
-success=false
+error_ln=$(grep -n '^@safety.*@asunsafe' "$@" |
+grep -v '@mtasc\?u.*@asunsafe\|@asunsafe{.*@asc\?u' |
+cut -d':' -f1,2)
+
+error_msg="@asunsafe tag empty."
+check_and_set_error
# Make sure safety lines marked as @acsafe do not contain any
# AC-Unsafe remark, which could be @acu, @ascu or even @mtacu or
# @mtascu.
-grep -n '^@safety.*@acsafe' "$@" |
-grep '@\(mt\)\?as\?cu' &&
-success=false
+error_ln=$(grep -n '^@safety.*@acsafe' "$@" |
+grep '@\(mt\)\?as\?cu' |
+cut -d':' -f1,2)
+
+error_msg="@acsafe tag contains AC-Unsafe remark."
+check_and_set_error
# Make sure @acunsafe lines contain at least one @acu remark (possibly
# implied by @ascu, @mtacu or @mtascu).
-grep -n '^@safety.*@acunsafe' "$@" |
-grep -v '@\(mtas\?\|as\)cu.*@acunsafe\|@acunsafe{.*@acu' &&
-success=false
+error_ln=$(grep -n '^@safety.*@acunsafe' "$@" |
+grep -v '@\(mtas\?\|as\)cu.*@acunsafe\|@acunsafe{.*@acu' |
+cut -d':' -f1,2)
+
+error_msg="@acunsafe tag empty."
+check_and_set_error
# Make sure there aren't duplicate remarks in the same safety note.
-grep -n '^@safety' "$@" |
-grep '[^:]\(@\(mt\|a[sc]\)[^ {]*{[^ ]*}\).*[^:]\1' &&
-success=false
+error_ln=$(grep -n '^@safety' "$@" |
+grep '[^:]\(@\(mt\|a[sc]\)[^ {]*{[^ ]*}\).*[^:]\1' |
+cut -d':' -f1,2)
+
+error_msg="duplicated remark."
+check_and_set_error
# Check that comments containing safety remarks do not contain {}s,
# that all @mt remarks appear before @as remarks, that in turn appear
# before @ac remarks, all properly blank-separated, and that an
# optional comment about exclusions is between []s at the end of the
# line.
-grep -n '^@c \+[^@ ]\+\( dup\)\?'\
+error_ln=$(grep -n '^@c \+[^@ ]\+\( dup\)\?'\
'\( @\(mt\|a[sc]\)[^ ]*\)*\( \[.*\]\)\?$' "$@" |
grep -v ':@c *[^@{}]*\( @mt[^ {}]*\)*'\
-'\( @as[^ {}]*\)*\( @ac[^ {}]*\)*\( \[.*\]\)\?$' &&
-success=false
+'\( @as[^ {}]*\)*\( @ac[^ {}]*\)*\( \[.*\]\)\?$' |
+cut -d':' -f1,2)
+
+error_msg="safety remark in wrong order (@mt, @as, @ac), no space "\
+"between remarks or bad format for optional comment."
+check_and_set_error
# Check that comments containing safety remarks do not contain
# duplicate remarks.
-grep -n '^@c \+[^@ ]\+\( dup\)\?'\
+error_ln=$(grep -n '^@c \+[^@ ]\+\( dup\)\?'\
'\( @\(mt\|a[sc]\)[^ ]*\)*\( \[.*\]\)\?$' "$@" |
-grep '[^:]\(@\(mt\|a[sc]\)[^ ]*\) \(.*[^:]\)\?\1\($\| \)' &&
-success=false
+grep '[^:]\(@\(mt\|a[sc]\)[^ ]*\) \(.*[^:]\)\?\1\($\| \)' |
+cut -d':' -f1,2)
+
+error_msg="duplicated remark in a comment."
+check_and_set_error
$success
diff --git a/manual/chk-typefun.awk b/manual/chk-typefun.awk
new file mode 100644
index 0000000..10a0ca4
--- /dev/null
+++ b/manual/chk-typefun.awk
@@ -0,0 +1,46 @@
+#! /usr/local/bin/gawk -f
+
+# Copyright 2015 Free Software Foundation, Inc.
+# This file is part of the GNU C Library.
+
+# The GNU C Library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+
+# The GNU C Library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+
+# You should have received a copy of the GNU Lesser General Public
+# License along with the GNU C Library; if not, see
+# <http://www.gnu.org/licenses/>.
+
+
+# Checks that every @deftypefun is follown by a @safety tag.
+# Displays an error in case it is not found.
+
+
+/^@deftypefun / {
+ # Found deftypefun
+
+ # Read next line. If they are comments, keep going.
+ getline inp
+ while (match (inp, "^@c(omment)? ") ||
+ match (inp, "^@deftypefunx ") ||
+ match (inp, "^@[cp]index ")) {
+
+ getline inp
+ }
+
+ # Done reading comments, it's a @safety tag or
+ # we have to report error.
+ if (!match (inp, "^@safety{")) {
+ printf "%s:%d\n", FILENAME, FNR
+ exit 1
+ }
+
+ # If we get here is because tags were correctly
+ # placed.
+}
diff --git a/manual/errno.texi b/manual/errno.texi
index 1068be3..b14db62 100644
--- a/manual/errno.texi
+++ b/manual/errno.texi
@@ -1335,7 +1335,7 @@ This function @code{strerror_r} is a GNU extension and it is declared in
@comment stdio.h
@comment ISO
@deftypefun void perror (const char *@var{message})
-@safety{@prelim{}@mtsafe{@mtasurace{:stderr}}@asunsafe{@asucorrupt{} @ascuintl{} @ascuheap{} @asulock{}}@acunsafe{@acucorrupt{} @aculock{} @acsmem{} @acsfd{}}}
+@safety{@prelim{}@mtunsafe{@mtasurace{:stderr}}@asunsafe{@asucorrupt{} @ascuintl{} @ascuheap{} @asulock{}}@acunsafe{@acucorrupt{} @aculock{} @acsmem{} @acsfd{}}}
@c Besides strerror_r's and some of fprintf's issues, if stderr is not
@c oriented yet, create a new stream with a dup of stderr's fd and write
@c to that instead of stderr, to avoid orienting it.
diff --git a/manual/install.texi b/manual/install.texi
index 63c41b0..1ebcca5 100644
--- a/manual/install.texi
+++ b/manual/install.texi
@@ -256,7 +256,8 @@ To format the @cite{GNU C Library Reference Manual} for printing, type
@w{@code{make dvi}}. You need a working @TeX{} installation to do
this. The distribution builds the on-line formatted version of the
manual, as Info files, as part of the build process. You can build
-them manually with @w{@code{make info}}.
+them manually with @w{@code{make info}}. Moreover, it's possible
+to get a copy in PDF format. To build it, type @w{@code{make pdf}}.
The library has a number of special-purpose configuration parameters
which you can find in @file{Makeconfig}. These can be overwritten with
--
2.1.0
^ permalink raw reply [flat|nested] 9+ messages in thread
end of thread, other threads:[~2016-03-14 12:01 UTC | newest]
Thread overview: 9+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2016-03-09 23:16 [PATCH v2] Improve debugging for manual safety annotations Juan Manuel Torres Palma
2016-03-10 9:46 ` ricaljasan
2016-03-14 12:01 ` Juan Manuel Torres Palma
-- strict thread matches above, loose matches on Subject: below --
2016-02-11 19:23 Juan Manuel Torres Palma
2016-02-22 18:29 ` Juan Manuel Torres Palma
2015-08-31 11:57 Juan Manuel Torres Palma
2015-09-03 22:28 ` Juan Manuel Torres Palma
2015-10-05 10:10 ` Juan Manuel Torres Palma
2015-10-05 11:23 ` Joseph Myers
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).