[dpdk-dev,v1] scripts: make checkpatch cleaner for renamed files

Message ID 1487563713-165778-1-git-send-email-david.hunt@intel.com (mailing list archive)
State Accepted, archived
Headers

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/Intel-compilation success Compilation OK

Commit Message

Hunt, David Feb. 20, 2017, 4:08 a.m. UTC
  When a file is renamed, a normal diff will include all the code of
the renamed file, and checkpatch will find warnings and errors,
even though it's just a rename.

This change will result in a 'rename' line in the diff, resulting
in a much cleaner checkpatches result.

Signed-off-by: David Hunt <david.hunt@intel.com>
---
 devtools/checkpatches.sh | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
  

Comments

Bruce Richardson Feb. 20, 2017, 11:16 a.m. UTC | #1
On Mon, Feb 20, 2017 at 04:08:33AM +0000, David Hunt wrote:
> When a file is renamed, a normal diff will include all the code of
> the renamed file, and checkpatch will find warnings and errors,
> even though it's just a rename.
> 
> This change will result in a 'rename' line in the diff, resulting
> in a much cleaner checkpatches result.
> 
> Signed-off-by: David Hunt <david.hunt@intel.com>
> ---
>  devtools/checkpatches.sh | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
> index cfe262b..6fbfb50 100755
> --- a/devtools/checkpatches.sh
> +++ b/devtools/checkpatches.sh
> @@ -89,7 +89,8 @@ check () { # <patch> <commit> <title>
>  	if [ -n "$1" ] ; then
>  		report=$($DPDK_CHECKPATCH_PATH $options "$1" 2>/dev/null)
>  	elif [ -n "$2" ] ; then
> -		report=$(git format-patch --no-stat --stdout -1 $commit |
> +		report=$(git format-patch --find-renames \
> +			--no-stat --stdout -1 $commit |
>  			$DPDK_CHECKPATCH_PATH $options - 2>/dev/null)
>  	else
>  		report=$($DPDK_CHECKPATCH_PATH $options - 2>/dev/null)
> -- 

This seems a good idea. Renaming legacy files which aren't checkpatch
clean throws up lots of issues that we don't want to fix as part of the
rename.

Acked-by: Bruce Richardson <bruce.richardson@intel.com>
  
Thomas Monjalon Feb. 21, 2017, 11:24 a.m. UTC | #2
2017-02-20 11:16, Bruce Richardson:
> On Mon, Feb 20, 2017 at 04:08:33AM +0000, David Hunt wrote:
> > When a file is renamed, a normal diff will include all the code of
> > the renamed file, and checkpatch will find warnings and errors,
> > even though it's just a rename.
> > 
> > This change will result in a 'rename' line in the diff, resulting
> > in a much cleaner checkpatches result.
> > 
> > Signed-off-by: David Hunt <david.hunt@intel.com>
> > ---
> >  devtools/checkpatches.sh | 3 ++-
> >  1 file changed, 2 insertions(+), 1 deletion(-)
> > 
> > diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
> > index cfe262b..6fbfb50 100755
> > --- a/devtools/checkpatches.sh
> > +++ b/devtools/checkpatches.sh
> > @@ -89,7 +89,8 @@ check () { # <patch> <commit> <title>
> >  	if [ -n "$1" ] ; then
> >  		report=$($DPDK_CHECKPATCH_PATH $options "$1" 2>/dev/null)
> >  	elif [ -n "$2" ] ; then
> > -		report=$(git format-patch --no-stat --stdout -1 $commit |
> > +		report=$(git format-patch --find-renames \
> > +			--no-stat --stdout -1 $commit |
> >  			$DPDK_CHECKPATCH_PATH $options - 2>/dev/null)
> >  	else
> >  		report=$($DPDK_CHECKPATCH_PATH $options - 2>/dev/null)
> 
> This seems a good idea. Renaming legacy files which aren't checkpatch
> clean throws up lots of issues that we don't want to fix as part of the
> rename.
> 
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Applied, thanks
  

Patch

diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
index cfe262b..6fbfb50 100755
--- a/devtools/checkpatches.sh
+++ b/devtools/checkpatches.sh
@@ -89,7 +89,8 @@  check () { # <patch> <commit> <title>
 	if [ -n "$1" ] ; then
 		report=$($DPDK_CHECKPATCH_PATH $options "$1" 2>/dev/null)
 	elif [ -n "$2" ] ; then
-		report=$(git format-patch --no-stat --stdout -1 $commit |
+		report=$(git format-patch --find-renames \
+			--no-stat --stdout -1 $commit |
 			$DPDK_CHECKPATCH_PATH $options - 2>/dev/null)
 	else
 		report=$($DPDK_CHECKPATCH_PATH $options - 2>/dev/null)