The contributor's guide includes the usage of both the checkpatches and check-git-log scripts, which needed to be updated to reflect the now standardised format.
Signed-off-by: Ciara Power <ciara.po...@intel.com> --- doc/guides/contributing/patches.rst | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index 59442824a..f11e4d7c7 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -429,22 +429,28 @@ Once the environment variable the script can be run as follows:: The script usage is:: - checkpatches.sh [-h] [-q] [-v] [patch1 [patch2] ...]]" + checkpatches.sh [-h] [-q] [-v] [-nX|-r range|patch1 [patch2] ...]" Where: * ``-h``: help, usage. * ``-q``: quiet. Don't output anything for files without issues. * ``-v``: verbose. +* ``-nX``: the number of commits to check. +* ``-r range``: the range to check, range must be a ``git log`` option. * ``patchX``: path to one or more patches. Then the git logs should be checked using the ``check-git-log.sh`` script. The script usage is:: - check-git-log.sh [range] + check-git-log.sh [-h] [-nX|-r range] -Where the range is a ``git log`` option. +Where: + +* ``-h``: help, usage. +* ``-nX``: the number of commits to check. +* ``-r range``: the range to check, range must be a ``git log`` option. .. _contrib_check_compilation: -- 2.17.1
