From patchwork Wed May 6 09:55:25 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Power, Ciara" X-Patchwork-Id: 69811 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 9ACA7A034F; Wed, 6 May 2020 11:56:57 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 23FA31D8E6; Wed, 6 May 2020 11:56:52 +0200 (CEST) Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by dpdk.org (Postfix) with ESMTP id 347331D8CC for ; Wed, 6 May 2020 11:56:50 +0200 (CEST) IronPort-SDR: aVlbepp10QPfjayu+v05Kk5/2BEAB3Cqj0B2aNcaDP/qP1F6FeXfpNJN4kexOjX6XST48Ax9Hc 9uvPp0AK+5ew== X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by fmsmga105.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 06 May 2020 02:56:49 -0700 IronPort-SDR: o7DzAejMpfgkUXV8I2dusT8wxe0ypIhjW3IZdgzOkCWOad0f0TPrHuACuOqRViCN52lpFzvdOC 2qJqf9SDT6/g== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.73,358,1583222400"; d="scan'208";a="461705911" Received: from silpixa00399953.ir.intel.com (HELO silpixa00399953.ger.corp.intel.com) ([10.237.222.53]) by fmsmga006.fm.intel.com with ESMTP; 06 May 2020 02:56:48 -0700 From: Ciara Power To: thomas@monjalon.net Cc: dev@dpdk.org, Ciara Power Date: Wed, 6 May 2020 10:55:25 +0100 Message-Id: <20200506095526.27664-2-ciara.power@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200506095526.27664-1-ciara.power@intel.com> References: <20200128150256.14339-1-ciara.power@intel.com> <20200506095526.27664-1-ciara.power@intel.com> Subject: [dpdk-dev] [PATCH v2 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 --- v2: Added exit 0 after print usage. --- devtools/check-git-log.sh | 33 ++++++++++++++++++++++++--------- devtools/checkpatches.sh | 2 +- 2 files changed, 25 insertions(+), 10 deletions(-) diff --git a/devtools/check-git-log.sh b/devtools/check-git-log.sh index 4e65be0e4b..efdfca27cc 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 + exit 0 # 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 42b833e0d7..e111c31d7d 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 Wed May 6 09:55:26 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Power, Ciara" X-Patchwork-Id: 69812 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 89874A034F; Wed, 6 May 2020 11:57:05 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 368411D8EE; Wed, 6 May 2020 11:56:54 +0200 (CEST) Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by dpdk.org (Postfix) with ESMTP id 3CDA61D8DF for ; Wed, 6 May 2020 11:56:51 +0200 (CEST) IronPort-SDR: tSgUrqw0p2Amme5OJPJ5mWISMaerXSXAKF+/6+wEHRNR8ROedSCVkSNRQ/Txv1oiUXvuwuQgPi kMOlX8rZMaNQ== X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga006.fm.intel.com ([10.253.24.20]) by fmsmga105.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 06 May 2020 02:56:50 -0700 IronPort-SDR: LROSLx606zCyr2d3ZY5b5pkhU7y04y4bfLlJLOnlLTWeu1ZWqn6yo91cwnLQl16KvOnhgq2EIU Cs/ya1ScVZOA== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.73,358,1583222400"; d="scan'208";a="461705916" Received: from silpixa00399953.ir.intel.com (HELO silpixa00399953.ger.corp.intel.com) ([10.237.222.53]) by fmsmga006.fm.intel.com with ESMTP; 06 May 2020 02:56:49 -0700 From: Ciara Power To: thomas@monjalon.net Cc: dev@dpdk.org, Ciara Power Date: Wed, 6 May 2020 10:55:26 +0100 Message-Id: <20200506095526.27664-3-ciara.power@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200506095526.27664-1-ciara.power@intel.com> References: <20200128150256.14339-1-ciara.power@intel.com> <20200506095526.27664-1-ciara.power@intel.com> Subject: [dpdk-dev] [PATCH v2 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 --- v2: Added appropriate exit codes based on failure status. --- devtools/check-git-log.sh | 45 +++++++++++++++++++++++++-------------- 1 file changed, 29 insertions(+), 16 deletions(-) diff --git a/devtools/check-git-log.sh b/devtools/check-git-log.sh index efdfca27cc..270fe391d7 100755 --- a/devtools/check-git-log.sh +++ b/devtools/check-git-log.sh @@ -61,7 +61,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 +79,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 +89,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 case (Rx/Tx, VF, L2, MAC, Linux ...) IFS=' @@ -109,9 +109,8 @@ for word in $(cat $words); do fi for bad_line in $bad; do bad_word=$(echo $bad_line | cut -d":" -f2 | grep -io $word) - if [ -n "$bad_word" ]; then - printf "Wrong headline case:\n\"$bad_line\": $bad_word --> $word\n" - fi + [ -z "$bad_word" ] || { printf "Wrong headline case:\n\ + \"$bad_line\": $bad_word --> $word\n" && failure=true;} done done @@ -119,27 +118,28 @@ done 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 @@ -148,7 +148,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 @@ -157,14 +158,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 fixtags=$(echo "$tags" | grep '^Fixes: ') @@ -177,11 +179,22 @@ 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 [ -n "$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' +[ -n "$failure" ] && exit 1 || exit 0