Re: [dpdk-dev] [PATCH v3 1/3] devtools: standardize script arguments

[Thomas Monjalon <thomas@monjalon.net>]

02/06/2020 15:53, Ciara Power:
> 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 <range>"
> 
> The checkpatches help print is also updated to include the "-h" option.
> 
> Signed-off-by: Ciara Power <ciara.power@intel.com>
> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
> 
> ---
> v3:
>   - Reworded check-git-log help text example.
>   - Added comment to indicate new and old format argument parsing.
> v2: Added exit 0 after print usage.
> ---
> --- a/devtools/check-git-log.sh
> +++ b/devtools/check-git-log.sh
> +	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.
> +	When no parameter is provided, script will use range starting from
> +	origin/master to HEAD.

I suggest this shorter sentence:
If no range provided, default is origin/master..HEAD.

> +# 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.
> +# e.g. To check only the last commit, ‘-n1’ or ‘-r@~..’ is used.

This example line is useless here.

> +# The old format allows for specifying patches by passing -X or range
> +# as the first argument.
> +# e.g. To check only the last commit, '-1'  or '@~..' is used as first argument.

This example line is useless here.