CbC/CbC_gcc: contrib/check_GNU

annotate contrib/check_GNU_style.sh @ 100:29a62213c1d0

add "code" syntax

author	Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp>
date	Sun, 05 Feb 2012 10:24:11 +0900
parents	561a7518be6b
children	04ced10e8804

rev	line source
68 561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	1 #!/bin/sh
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	2
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	3 # Checks some of the GNU style formatting rules in a set of patches.
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	4 # Copyright (C) 2010 Free Software Foundation, Inc.
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	5 # Contributed by Sebastian Pop <sebastian.pop@amd.com>
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	6
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	7 # This program is free software; you can redistribute it and/or modify
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	8 # it under the terms of the GNU General Public License as published by
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	9 # the Free Software Foundation; either version 3 of the License, or
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	10 # (at your option) any later version.
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	11
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	12 # This program is distributed in the hope that it will be useful,
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	15 # GNU General Public License for more details.
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	16
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	17 # You should have received a copy of the GNU General Public License
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	18 # along with this program; if not, write to the Free Software
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	19 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	20
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	21 usage() {
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	22 cat <<EOF
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	23 check_GNU_style.sh [patch]...
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	24
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	25 Checks the patches for some of the GNU style formatting problems.
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	26 Please note that these checks are not always accurate, and
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	27 complete. The reference documentation of the GNU Coding Standards
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	28 can be found here: http://www.gnu.org/prep/standards_toc.html
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	29 and there are also some additional coding conventions for GCC:
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	30 http://gcc.gnu.org/codingconventions.html
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	31
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	32 EOF
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	33 exit 1
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	34 }
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	35
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	36 test $# -eq 0 && usage
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	37
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	38 tmp=check_GNU_style.tmp
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	39
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	40 # Grep
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	41 g (){
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	42 msg="$1"
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	43 arg="$2"
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	44 shift 2
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	45 grep -nH '^+' $* \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	46 \| grep -v ':+++' \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	47 \| egrep --color=always -- "$arg" \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	48 > $tmp && printf "\n$msg\n"
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	49 cat $tmp
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	50 }
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	51
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	52 # And Grep
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	53 ag (){
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	54 msg="$1"
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	55 arg1="$2"
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	56 arg2="$3"
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	57 shift 3
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	58 grep -nH '^+' $* \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	59 \| grep -v ':+++' \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	60 \| egrep --color=always -- "$arg1" \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	61 \| egrep --color=always -- "$arg2" \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	62 > $tmp && printf "\n$msg\n"
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	63 cat $tmp
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	64 }
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	65
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	66 # reVerse Grep
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	67 vg (){
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	68 msg="$1"
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	69 varg="$2"
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	70 arg="$3"
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	71 shift 3
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	72 grep -nH '^+' $* \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	73 \| grep -v ':+++' \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	74 \| egrep -v -- "$varg" \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	75 \| egrep --color=always -- "$arg" \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	76 > $tmp && printf "\n$msg\n"
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	77 cat $tmp
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	78 }
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	79
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	80 col (){
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	81 msg="$1"
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	82 shift 1
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	83 grep -nH '^+' $* \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	84 \| grep -v ':+++' \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	85 \| cut -f 2 -d '+' \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	86 \| awk '{ if (length ($0) > 80) print $0 }' \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	87 > $tmp
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	88 if [ -s $tmp ]; then
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	89 printf "\n$msg\n"
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	90 cat $tmp
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	91 fi
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	92 }
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	93
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	94 col 'Lines should not exceed 80 characters.' $*
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	95
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	96 g 'Trailing whitespace.' \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	97 '[[:space:]]$' $*
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	98
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	99 g 'Space before dot.' \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	100 '[[:alnum:]][[:blank:]]+\.' $*
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	101
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	102 g 'Dot, space, space, new sentence.' \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	103 '[[:alnum:]]\.([[:blank:]]\|[[:blank:]]{3,})[[:alnum:]]' $*
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	104
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	105 g 'Dot, space, space, end of comment.' \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	106 '[[:alnum:]]\.([[:blank:]]{0,1}\|[[:blank:]]{3,})\/' $
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	107
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	108 g 'Sentences should end with a dot. Dot, space, space, end of the comment.' \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	109 '[[:alnum:]][[:blank:]]\/' $*
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	110
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	111 vg 'There should be exactly one space between function name and parentheses.' \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	112 '\#define' '[[:alnum:]]([^[:blank:]]\|[[:blank:]]{2,})\(' $*
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	113
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	114 g 'There should be no space before closing parentheses.' \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	115 '[[:graph:]][[:blank:]]+\)' $*
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	116
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	117 ag 'Braces should be on a separate line.' \
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	118 '\{' 'if[[:blank:]]\(\|while[[:blank:]]\(\|switch[[:blank:]]\(' $*
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	119
561a7518be6b update gcc-4.6 Nobuyasu Oshiro <dimolto@cr.ie.u-ryukyu.ac.jp> parents: diff changeset	120

Mercurial > hg > CbC > CbC_gcc

annotate contrib/check_GNU_style.sh @ 100:29a62213c1d0