diff --git a/devtools/check-git-log.sh b/devtools/check-git-log.sh index 4e65be0e4b..e5b4302685 100755 --- a/devtools/check-git-log.sh +++ b/devtools/check-git-log.sh @@ -7,23 +7,44 @@ # 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. To check only the last commit, ‘-n1’ or ‘-r@~..’ is used. + If no range provided, default is origin/master..HEAD. END_OF_HELP - exit -fi +} selfdir=$(dirname $(readlink -f $0)) +# The script caters for two formats, the new preferred format, and the old +# format to ensure backward compatibility. +# The new format is aligned with the format of the checkpatches script, +# and allows for specifying the patches to check by passing -nX or -r range. +# The old format allows for specifying patches by passing -X or range +# as the first argument. 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 0b94a31690..acf921ae0d 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. diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index 16b40225f2..261c4b8486 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -429,23 +429,16 @@ Once the environment variable is set, the script can be run as follows:: The script usage is:: - checkpatches.sh [-h] [-q] [-v] [patch1 [patch2] ...]]" - -Where: - -* ``-h``: help, usage. -* ``-q``: quiet. Don't output anything for files without issues. -* ``-v``: verbose. -* ``patchX``: path to one or more patches. + checkpatches.sh [-h] [-q] [-v] [-nX|-r range|patch1 [patch2] ...] Then the git logs should be checked using the ``check-git-log.sh`` script. The script usage is:: - check-git-log.sh [range] - -Where the range is a ``git log`` option. + check-git-log.sh [-h] [-nX|-r range] +For both of the above scripts, the -n option is used to specify a number of commits from HEAD, +and the -r option allows the user specify a ``git log`` range. .. _contrib_check_compilation: