diff mbox

[dpdk-dev] scripts: check commits with checkpatch

Message ID 1464858795-3152-1-git-send-email-thomas.monjalon@6wind.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers

Commit Message

Thomas Monjalon June 2, 2016, 9:13 a.m. UTC 
  The new option -n allows to give a number of commits to check
from the git HEAD.
If neither -n nor patch files are given, the commits after
origin/master are checked.

Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
---
 scripts/checkpatches.sh | 45 ++++++++++++++++++++++++++++++++++++---------
 1 file changed, 36 insertions(+), 9 deletions(-)

Comments

Bruce Richardson June 2, 2016, 12:33 p.m. UTC | #1 
On Thu, Jun 02, 2016 at 11:13:15AM +0200, Thomas Monjalon wrote:
> The new option -n allows to give a number of commits to check
> from the git HEAD.
> If neither -n nor patch files are given, the commits after
> origin/master are checked.
> 

Yep, I love it, exactly what I wanted to replace my own checkpatch script wrapper!

> Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
> ---
>  scripts/checkpatches.sh | 45 ++++++++++++++++++++++++++++++++++++---------
>  1 file changed, 36 insertions(+), 9 deletions(-)
> 
> diff --git a/scripts/checkpatches.sh b/scripts/checkpatches.sh
<snip>
> @@ -74,17 +76,42 @@ if [ ! -x "$DPDK_CHECKPATCH_PATH" ] ; then
>  	exit 1
>  fi
>  
> +total=0
>  status=0
> -for p in "$@" ; do
> -	! $verbose || printf '\n### %s\n\n' "$p"
> -	report=$($DPDK_CHECKPATCH_PATH $options "$p" 2>/dev/null)
> +
> +check () { # <patch> <commit> <title>
> +	total=$(($total + 1))
> +	! $verbose || printf '\n### %s\n\n' "$3"
> +	if [ -n "$1" ] ; then
> +		report=$($DPDK_CHECKPATCH_PATH $options "$1" 2>/dev/null)
> +	elif [ -n "$2" ] ; then
> +		report=$(git format-patch --stdout -1 $commit |
> +			$DPDK_CHECKPATCH_PATH $options - 2>/dev/null)
> +	fi

Testing this out here, I find that git format-patch includes the diff stats
in the output, which then can trigger long-line warnings for the commit message.

	WARNING:COMMIT_LOG_LONG_LINE: Possible unwrapped commit description (prefer a maximum 75 chars per line)
	#8:
	 examples/my-new-test-app/basicfwd.c | 342 +++++++++++++++++++++++++++++++++++++

To fix this, I suggest replacing "format-patch --stdout" with "show --format=email"
since that should give the same output just without the change stats.

With this one adjustment:

Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Thomas Monjalon June 2, 2016, 1:15 p.m. UTC | #2 
2016-06-02 13:33, Bruce Richardson:
> Testing this out here, I find that git format-patch includes the diff stats
> in the output, which then can trigger long-line warnings for the commit message.
> 
> 	WARNING:COMMIT_LOG_LONG_LINE: Possible unwrapped commit description (prefer a maximum 75 chars per line)
> 	#8:
> 	 examples/my-new-test-app/basicfwd.c | 342 +++++++++++++++++++++++++++++++++++++
> 
> To fix this, I suggest replacing "format-patch --stdout" with "show --format=email"
> since that should give the same output just without the change stats.

or format-patch --no-stat
Bruce Richardson June 2, 2016, 1:23 p.m. UTC | #3 
On Thu, Jun 02, 2016 at 03:15:54PM +0200, Thomas Monjalon wrote:
> 2016-06-02 13:33, Bruce Richardson:
> > Testing this out here, I find that git format-patch includes the diff stats
> > in the output, which then can trigger long-line warnings for the commit message.
> > 
> > 	WARNING:COMMIT_LOG_LONG_LINE: Possible unwrapped commit description (prefer a maximum 75 chars per line)
> > 	#8:
> > 	 examples/my-new-test-app/basicfwd.c | 342 +++++++++++++++++++++++++++++++++++++
> > 
> > To fix this, I suggest replacing "format-patch --stdout" with "show --format=email"
> > since that should give the same output just without the change stats.
> 
> or format-patch --no-stat
>
Sure, whatever works! :-) It's just a longer command :-)

/Bruce
Thomas Monjalon June 7, 2016, 7:43 a.m. UTC | #4 
2016-06-02 13:33, Bruce Richardson:
> On Thu, Jun 02, 2016 at 11:13:15AM +0200, Thomas Monjalon wrote:
> > The new option -n allows to give a number of commits to check
> > from the git HEAD.
> > If neither -n nor patch files are given, the commits after
> > origin/master are checked.
> > 
> 
> Yep, I love it, exactly what I wanted to replace my own checkpatch script wrapper!
> 
> > Signed-off-by: Thomas Monjalon <thomas.monjalon@6wind.com>
> 
> Testing this out here, I find that git format-patch includes the diff stats
> in the output, which then can trigger long-line warnings for the commit message.
> 
> 	WARNING:COMMIT_LOG_LONG_LINE: Possible unwrapped commit description (prefer a maximum 75 chars per line)
> 	#8:
> 	 examples/my-new-test-app/basicfwd.c | 342 +++++++++++++++++++++++++++++++++++++
> 
> To fix this, I suggest replacing "format-patch --stdout" with "show --format=email"
> since that should give the same output just without the change stats.
> 
> With this one adjustment:
> 
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Applied with --no-stat adjustment.
diff mbox

Patch

diff --git a/scripts/checkpatches.sh b/scripts/checkpatches.sh
index 4cae86d..24a246d 100755
--- a/scripts/checkpatches.sh
+++ b/scripts/checkpatches.sh
@@ -48,17 +48,19 @@  NEW_TYPEDEFS,COMPARISON_TO_NULL"
 
 print_usage () {
 	cat <<- END_OF_HELP
-	usage: $(basename $0) [-q] [-v] [patch1 [patch2] ...]]
+	usage: $(basename $0) [-q] [-v] [-nX|patch1 [patch2] ...]]
 
 	Run Linux kernel checkpatch.pl with DPDK options.
 	The environment variable DPDK_CHECKPATCH_PATH must be set.
 	END_OF_HELP
 }
 
+number=0
 quiet=false
 verbose=false
-while getopts hqv ARG ; do
+while getopts hn:qv ARG ; do
 	case $ARG in
+		n ) number=$OPTARG ;;
 		q ) quiet=true && options="$options --no-summary" ;;
 		v ) verbose=true ;;
 		h ) print_usage ; exit 0 ;;
@@ -74,17 +76,42 @@  if [ ! -x "$DPDK_CHECKPATCH_PATH" ] ; then
 	exit 1
 fi
 
+total=0
 status=0
-for p in "$@" ; do
-	! $verbose || printf '\n### %s\n\n' "$p"
-	report=$($DPDK_CHECKPATCH_PATH $options "$p" 2>/dev/null)
+
+check () { # <patch> <commit> <title>
+	total=$(($total + 1))
+	! $verbose || printf '\n### %s\n\n' "$3"
+	if [ -n "$1" ] ; then
+		report=$($DPDK_CHECKPATCH_PATH $options "$1" 2>/dev/null)
+	elif [ -n "$2" ] ; then
+		report=$(git format-patch --stdout -1 $commit |
+			$DPDK_CHECKPATCH_PATH $options - 2>/dev/null)
+	fi
 	[ $? -ne 0 ] || continue
-	$verbose || printf '\n### %s\n\n' "$p"
+	$verbose || printf '\n### %s\n\n' "$3"
 	printf '%s\n' "$report" | head -n -6
 	status=$(($status + 1))
-done
-pass=$(($# - $status))
-$quiet || printf '%d/%d valid patch' $pass $#
+}
+
+if [ -z "$1" ] ; then
+	if [ $number -eq 0 ] ; then
+		commits=$(git rev-list origin/master..)
+	else
+		commits=$(git rev-list --max-count=$number HEAD)
+	fi
+	for commit in $commits ; do
+		subject=$(git log --format='%s' -1 $commit)
+		check '' $commit "$subject"
+	done
+else
+	for patch in "$@" ; do
+		subject=$(sed -n 's,^Subject: ,,p' "$patch")
+		check "$patch" '' "$subject"
+	done
+fi
+pass=$(($total - $status))
+$quiet || printf '%d/%d valid patch' $pass $total
 $quiet || [ $pass -le 1 ] || printf 'es'
 $quiet || printf '\n'
 exit $status