mirror of
https://sourceware.org/git/glibc.git
synced 2024-11-24 05:50:14 +00:00
a2b581cb25
for ChangeLog * manual/Makefile ($(objpfx)stamp-summary): Require check-safety.sh to pass. * manual/check-safety.sh: Wish for verification that every @deftypefn and @deftypefun is followed by a @safety remark.
125 lines
4.5 KiB
Bash
125 lines
4.5 KiB
Bash
#! /bin/sh
|
|
|
|
# Copyright 2014 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/>.
|
|
|
|
|
|
# Check that the @safety notes are self-consistent, i.e., that they're
|
|
# in proper order (mt then as then ac), that remarks appear within
|
|
# corresponding sections (mt within mt, etc), that unsafety always has
|
|
# an explicit reason and when there's a reason for unsafety it's not
|
|
# safe, and that there aren't duplicates remarks.
|
|
|
|
|
|
success=:
|
|
|
|
# If no arguments are given, take all *.texi files in the current directory.
|
|
test $# != 0 || set *.texi
|
|
|
|
# FIXME: check that each @deftypefu?n is followed by a @safety note,
|
|
# with nothing but @deftypefu?nx and comment lines in between. (There
|
|
# might be more stuff too).
|
|
|
|
|
|
# Check that all safety remarks have entries for all of MT, AS and AC,
|
|
# in this order, with an optional prelim note before them.
|
|
grep -n '^@safety' "$@" |
|
|
grep -v ':@safety{\(@prelim{}\)\?@mt\(un\)\?safe{.*}'\
|
|
'@as\(un\)\?safe{.*}@ac\(un\)\?safe{.*}}' &&
|
|
success=false
|
|
|
|
# Check that @mt-started notes appear within @mtsafe or @mtunsafe,
|
|
# that @as-started notes appear within @assafe or @asunsafe, and that
|
|
# @ac-started notes appear within @acsafe or @acunsafe. Also check
|
|
# that @mt, @as and @ac are followed by an s (for safe) or u (for
|
|
# 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' "$@" |
|
|
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
|
|
|
|
# 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
|
|
|
|
# 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
|
|
|
|
# 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
|
|
|
|
# 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
|
|
|
|
# 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
|
|
|
|
# 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
|
|
|
|
# Make sure there aren't duplicate remarks in the same safety note.
|
|
grep -n '^@safety' "$@" |
|
|
grep '[^:]\(@\(mt\|a[sc]\)[^ {]*{[^ ]*}\).*[^:]\1' &&
|
|
success=false
|
|
|
|
# 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\)\?'\
|
|
'\( @\(mt\|a[sc]\)[^ ]*\)*\( \[.*\]\)\?$' "$@" |
|
|
grep -v ':@c *[^@{}]*\( @mt[^ {}]*\)*'\
|
|
'\( @as[^ {}]*\)*\( @ac[^ {}]*\)*\( \[.*\]\)\?$' &&
|
|
success=false
|
|
|
|
# Check that comments containing safety remarks do not contain
|
|
# duplicate remarks.
|
|
grep -n '^@c \+[^@ ]\+\( dup\)\?'\
|
|
'\( @\(mt\|a[sc]\)[^ ]*\)*\( \[.*\]\)\?$' "$@" |
|
|
grep '[^:]\(@\(mt\|a[sc]\)[^ ]*\) \(.*[^:]\)\?\1\($\| \)' &&
|
|
success=false
|
|
|
|
$success
|