[ofa-general] [RFC PATCH] - scripts/CodingStyle_sizeof - standardize sizeof and [PATCH] drivers/infiniband - standardize sizeof(foo)

Joe Perches joe at perches.com
Tue Jul 1 09:49:46 PDT 2008


Scripts could be used to generate CodingStyle patches
in reviewable units.

For instance, kernel source has multiple style uses of sizeof

sizeof(foo)
sizeof foo
sizeof (foo)

Perhaps Julia Lawall semantic patches might work better,
but this script might help standardize on the CodingStyle
preferred sizeof(foo).

It's an imperfect tool.  Any patch generated by a tool
(yes, I just called myself a tool..:) must be inspected
and verified before being applied.

A sample patch of drivers_infiniband.patch generated by
$ scripts/CodingStyle_sizeof drivers/infiniband
is also attached as bz2

Signed-off-by: Joe Perches <joe at perches.com>
---
 scripts/CodingStyle_sizeof |   33 +++++++++++++++++++++++++++++++++
 1 files changed, 33 insertions(+), 0 deletions(-)

diff --git a/scripts/CodingStyle_sizeof b/scripts/CodingStyle_sizeof
new file mode 100755
index 0000000..7f2444f
--- /dev/null
+++ b/scripts/CodingStyle_sizeof
@@ -0,0 +1,33 @@
+#!/bin/bash
+if [ $# -ne 1 ] ; then
+    echo "$0 takes 1 argument: directory|file"
+    exit
+fi
+if [[ ! -f $1 && ! -d $1 ]] ; then
+    echo "Directory or file: $1 not found"
+    exit
+fi
+if [ -d $1 ] ; then
+    findfile="find $1 -name \"*.[ch]\""
+else
+    findfile="ls $1"
+fi
+patchfile=$1.patch
+patchfile=${patchfile//\//_}
+git checkout $1
+for file in $(eval $findfile) ; do
+    sed -r -i -e 's/\bsizeof\s+([^\(][^ ;,]+)\s*/sizeof\(\1\)/g' $file
+    sed -r -i -e 's/\bsizeof\s+/sizeof/g' $file
+done
+git diff -p --stat $1 > $patchfile
+# fixup the generated diff
+# add space between close paren and (brace, assign, arithmetic or logical test)
+sed -r -i -e 's/^\+(.*)\)([\{\=\+\*\/\<\>\|\!\&\?\-])/\+\1\) \2/g' $patchfile
+# remove space between ') ->' added by sed above
+sed -r -i -e 's/^\+(.*)\) ->/\+\1\)->/g' $patchfile
+# fix declaration with sizeof brackets ie: char foo[sizeof("bar")];
+sed -r -i -e 's/^\+(.*)\[(.*)\((.*)\]\)/\+\1\[\2\(\3\)\]/g' $patchfile
+# fix sizeof array element ie: sizeof(foo->bar[n])
+sed -r -i -e 's/^\+(.*)sizeof\((.*)\[(.*)\)\]/\+\1sizeof\(\2\[\3\]\)/g' $patchfile
+git checkout $1
+patch -p1 < $patchfile

-------------- next part --------------
A non-text attachment was scrubbed...
Name: drivers_infiniband.patch.bz2
Type: application/x-bzip
Size: 37502 bytes
Desc: not available
URL: <http://lists.openfabrics.org/pipermail/general/attachments/20080701/7b5c01cd/attachment.bin>


More information about the general mailing list