From patchwork Tue Jan 28 15:02:55 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Power, Ciara" X-Patchwork-Id: 65242 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 2ECAFA04B3; Tue, 28 Jan 2020 16:22:21 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id E081C1C43D; Tue, 28 Jan 2020 16:22:12 +0100 (CET) Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by dpdk.org (Postfix) with ESMTP id B2DD41C2FB for ; Tue, 28 Jan 2020 16:22:09 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga007.jf.intel.com ([10.7.209.58]) by orsmga105.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 28 Jan 2020 07:13:50 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.70,374,1574150400"; d="scan'208";a="217636681" Received: from silpixa00399953.ir.intel.com (HELO silpixa00399953.ger.corp.intel.com) ([10.237.222.53]) by orsmga007.jf.intel.com with ESMTP; 28 Jan 2020 07:13:49 -0800 From: Ciara Power To: thomas@monjalon.net Cc: dev@dpdk.org, Ciara Power Date: Tue, 28 Jan 2020 15:02:55 +0000 Message-Id: <20200128150256.14339-2-ciara.power@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200128150256.14339-1-ciara.power@intel.com> References: <20200128150256.14339-1-ciara.power@intel.com> Subject: [dpdk-dev] [PATCH 1/2] devtools: standardize script arguments X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" This patch modifies the arguments expected by the check-git-log script, to match the format of arguments for the checkpatches script. Both scripts now take certain argument options in the same format, making them easier to use. e.g. Both now take a commit ID range by "-r " The checkpatches help print is also updated to include the "-h" option. Signed-off-by: Ciara Power Acked-by: Ferruh Yigit --- devtools/check-git-log.sh | 31 +++++++++++++++++++++++-------- devtools/checkpatches.sh | 2 +- 2 files changed, 24 insertions(+), 9 deletions(-) diff --git a/devtools/check-git-log.sh b/devtools/check-git-log.sh index f9d055039..22b2a6d84 100755 --- a/devtools/check-git-log.sh +++ b/devtools/check-git-log.sh @@ -7,23 +7,38 @@ # If any doubt about the formatting, please check in the most recent history: # git log --format='%>|(15)%cr %s' --reverse | grep -i -if [ "$1" = '-h' -o "$1" = '--help' ] ; then +print_usage () { cat <<- END_OF_HELP - usage: $(basename $0) [-h] [range] + usage: $(basename $0) [-h] [-nX|-r range] Check commit log formatting. - The git range can be specified as a "git log" option, - e.g. -1 to check only the latest commit. - The default range starts from origin/master to HEAD. + The git commits to be checked can be specified as a "git log" option, + by latest git commits limited with -n option, or commits in the git + range specified with -r option. + e.g. -n1 to check only the latest commit. + The default starts from origin/master to HEAD. END_OF_HELP exit -fi +} selfdir=$(dirname $(readlink -f $0)) range=${1:-origin/master..} + +if [ "$range" = '--help' ] ; then + print_usage # convert -N to HEAD~N.. in order to comply with git-log-fixes.sh getopts -if printf -- $range | grep -q '^-[0-9]\+' ; then - range="HEAD$(printf -- $range | sed 's,^-,~,').." +elif printf -- "$range" | grep -q '^-[0-9]\+' ; then + range="HEAD$(printf -- "$range" | sed 's,^-,~,').." +else + while getopts hr:n: ARG ; do + case $ARG in + n ) range="HEAD~$OPTARG.." ;; + r ) range=$OPTARG ;; + h ) print_usage ; exit 0 ;; + ? ) print_usage ; exit 1 ;; + esac + done + shift $(($OPTIND - 1)) fi commits=$(git log --format='%h' --reverse $range) diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh index b16bace92..084191984 100755 --- a/devtools/checkpatches.sh +++ b/devtools/checkpatches.sh @@ -38,7 +38,7 @@ options="$options $DPDK_CHECKPATCH_OPTIONS" print_usage () { cat <<- END_OF_HELP - usage: $(basename $0) [-q] [-v] [-nX|-r range|patch1 [patch2] ...]] + usage: $(basename $0) [-h] [-q] [-v] [-nX|-r range|patch1 [patch2] ...] Run Linux kernel checkpatch.pl with DPDK options. The environment variable DPDK_CHECKPATCH_PATH must be set. From patchwork Tue Jan 28 15:02:56 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Power, Ciara" X-Patchwork-Id: 65243 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 89904A04B3; Tue, 28 Jan 2020 16:22:28 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 5BF8E1D14D; Tue, 28 Jan 2020 16:22:14 +0100 (CET) Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by dpdk.org (Postfix) with ESMTP id 8D9C71C43A for ; Tue, 28 Jan 2020 16:22:11 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga007.jf.intel.com ([10.7.209.58]) by orsmga105.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 28 Jan 2020 07:13:52 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.70,374,1574150400"; d="scan'208";a="217636685" Received: from silpixa00399953.ir.intel.com (HELO silpixa00399953.ger.corp.intel.com) ([10.237.222.53]) by orsmga007.jf.intel.com with ESMTP; 28 Jan 2020 07:13:50 -0800 From: Ciara Power To: thomas@monjalon.net Cc: dev@dpdk.org, Ciara Power Date: Tue, 28 Jan 2020 15:02:56 +0000 Message-Id: <20200128150256.14339-3-ciara.power@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200128150256.14339-1-ciara.power@intel.com> References: <20200128150256.14339-1-ciara.power@intel.com> Subject: [dpdk-dev] [PATCH 2/2] devtools: added stats print X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" When all checks are completed on the specified commit logs, the script indicates if all are valid, or if there were some failures. Signed-off-by: Ciara Power Acked-by: Ferruh Yigit --- devtools/check-git-log.sh | 45 ++++++++++++++++++++++++++------------- 1 file changed, 30 insertions(+), 15 deletions(-) diff --git a/devtools/check-git-log.sh b/devtools/check-git-log.sh index 22b2a6d84..2f7a9f344 100755 --- a/devtools/check-git-log.sh +++ b/devtools/check-git-log.sh @@ -23,6 +23,7 @@ print_usage () { selfdir=$(dirname $(readlink -f $0)) range=${1:-origin/master..} +failure=false if [ "$range" = '--help' ] ; then print_usage @@ -61,7 +62,7 @@ bad=$(echo "$headlines" | grep --color=always \ -e ':[^ ]' \ -e ' :' \ | sed 's,^,\t,') -[ -z "$bad" ] || printf "Wrong headline format:\n$bad\n" +[ -z "$bad" ] || { printf "Wrong headline format:\n$bad\n" && failure=true;} # check headline prefix when touching only drivers, e.g. net/ bad=$(for commit in $commits ; do @@ -79,7 +80,7 @@ bad=$(for commit in $commits ; do echo "$headline" | grep -v "^$drv" fi done | sed 's,^,\t,') -[ -z "$bad" ] || printf "Wrong headline prefix:\n$bad\n" +[ -z "$bad" ] || { printf "Wrong headline prefix:\n$bad\n" && failure=true;} # check headline label for common typos bad=$(echo "$headlines" | grep --color=always \ @@ -89,14 +90,14 @@ bad=$(echo "$headlines" | grep --color=always \ -e 'test-pmd' \ -e '^bond:' \ | sed 's,^,\t,') -[ -z "$bad" ] || printf "Wrong headline label:\n$bad\n" +[ -z "$bad" ] || { printf "Wrong headline label:\n$bad\n" && failure=true;} # check headline lowercase for first words bad=$(echo "$headlines" | grep --color=always \ -e '^.*[[:upper:]].*:' \ -e ': *[[:upper:]]' \ | sed 's,^,\t,') -[ -z "$bad" ] || printf "Wrong headline uppercase:\n$bad\n" +[ -z "$bad" ] || { printf "Wrong headline uppercase:\n$bad\n" && failure=true;} # check headline uppercase (Rx/Tx, VF, L2, MAC, Linux, ARM...) bad=$(echo "$headlines" | grep -E --color=always \ @@ -142,39 +143,41 @@ bad=$(echo "$headlines" | grep -E --color=always \ | grep \ -v ':.*\' \ | sed 's,^,\t,') -[ -z "$bad" ] || printf "Wrong headline lowercase:\n$bad\n" +[ -z "$bad" ] || { printf "Wrong headline lowercase:\n$bad\n" && failure=true;} # special case check for VMDq to give good error message bad=$(echo "$headlines" | grep -E --color=always \ -e '\<(vmdq|VMDQ)\>' \ | sed 's,^,\t,') -[ -z "$bad" ] || printf "Wrong headline capitalization, use 'VMDq':\n$bad\n" +[ -z "$bad" ] || { printf "Wrong headline capitalization, use 'VMDq':\n$bad\n"\ + && failure=true;} # check headline length (60 max) bad=$(echo "$headlines" | awk 'length>60 {print}' | sed 's,^,\t,') -[ -z "$bad" ] || printf "Headline too long:\n$bad\n" +[ -z "$bad" ] || { printf "Headline too long:\n$bad\n" && failure=true;} # check body lines length (75 max) bad=$(echo "$bodylines" | grep -v '^Fixes:' | awk 'length>75 {print}' | sed 's,^,\t,') -[ -z "$bad" ] || printf "Line too long:\n$bad\n" +[ -z "$bad" ] || { printf "Line too long:\n$bad\n" && failure=true;} # check starting commit message with "It" bad=$(for commit in $commits ; do firstbodyline=$(git log --format='%b' -1 $commit | head -n1) echo "$firstbodyline" | grep --color=always -ie '^It ' done | sed 's,^,\t,') -[ -z "$bad" ] || printf "Wrong beginning of commit message:\n$bad\n" +[ -z "$bad" ] || { printf "Wrong beginning of commit message:\n$bad\n"\ + && failure=true;} # check tags spelling bad=$(echo "$tags" | grep -v "^$bytag [^,]* <.*@.*>$" | grep -v '^Fixes: [0-9a-f]\{7\}[0-9a-f]* (".*")$' | sed 's,^.,\t&,') -[ -z "$bad" ] || printf "Wrong tag:\n$bad\n" +[ -z "$bad" ] || { printf "Wrong tag:\n$bad\n" && failure=true;} # check missing Coverity issue: tag bad=$(for commit in $commits; do @@ -183,7 +186,8 @@ bad=$(for commit in $commits; do echo "$body" | grep -q '^Coverity issue:' && continue git log --format='\t%s' -1 $commit done) -[ -z "$bad" ] || printf "Missing 'Coverity issue:' tag:\n$bad\n" +[ -z "$bad" ] || { printf "Missing 'Coverity issue:' tag:\n$bad\n"\ + && failure=true;} # check missing Bugzilla ID: tag bad=$(for commit in $commits; do @@ -192,14 +196,15 @@ bad=$(for commit in $commits; do echo "$body" | grep -q '^Bugzilla ID:' && continue git log --format='\t%s' -1 $commit done) -[ -z "$bad" ] || printf "Missing 'Bugzilla ID:' tag:\n$bad\n" +[ -z "$bad" ] || { printf "Missing 'Bugzilla ID:' tag:\n$bad\n"\ + && failure=true;} # check missing Fixes: tag bad=$(for fix in $fixes ; do git log --format='%b' -1 $fix | grep -q '^Fixes: ' || git log --format='\t%s' -1 $fix done) -[ -z "$bad" ] || printf "Missing 'Fixes' tag:\n$bad\n" +[ -z "$bad" ] || { printf "Missing 'Fixes' tag:\n$bad\n" && failure=true;} # check Fixes: reference IFS=' @@ -214,11 +219,21 @@ bad=$(for fixtag in $fixtags ; do fi printf "$fixtag" | grep -v "^$good$" done | sed 's,^,\t,') -[ -z "$bad" ] || printf "Wrong 'Fixes' reference:\n$bad\n" +[ -z "$bad" ] || { printf "Wrong 'Fixes' reference:\n$bad\n" && failure=true;} # check Cc: stable@dpdk.org for fixes bad=$(for fix in $stablefixes ; do git log --format='%b' -1 $fix | grep -qi '^Cc: *stable@dpdk.org' || git log --format='\t%s' -1 $fix done) -[ -z "$bad" ] || printf "Is it candidate for Cc: stable@dpdk.org backport?\n$bad\n" +[ -z "$bad" ] || { printf "Is it candidate for Cc: stable@dpdk.org backport?\n$bad\n"\ + && failure=true;} + +total=$(echo "$commits" | wc -l) +if $failure ; then + printf "\nInvalid patch(es) found - checked $total patch" +else + printf "\n$total/$total valid patch" +fi +[ $total -le 1 ] || printf 'es' +printf '\n'