From: Ciara Power <ciara.power@intel.com>
To: thomas@monjalon.net, john.mcnamara@intel.com, marko.kovacevic@intel.com
Cc: ferruh.yigit@intel.com, dev@dpdk.org,
Ciara Power <ciara.power@intel.com>
Subject: [dpdk-dev] [PATCH v3 3/3] doc/guides: updated script usage for checking patches
Date: Tue, 2 Jun 2020 14:53:19 +0100 [thread overview]
Message-ID: <20200602135319.21457-4-ciara.power@intel.com> (raw)
In-Reply-To: <20200602135319.21457-1-ciara.power@intel.com>
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.power@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
next prev parent reply other threads:[~2020-06-02 13:58 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-28 15:02 [dpdk-dev] [PATCH 0/2] standardize devtools check scripts Ciara Power
2020-01-28 15:02 ` [dpdk-dev] [PATCH 1/2] devtools: standardize script arguments Ciara Power
2020-01-28 15:40 ` Ferruh Yigit
2020-02-22 20:53 ` Thomas Monjalon
2020-03-31 13:11 ` Power, Ciara
2020-01-28 15:02 ` [dpdk-dev] [PATCH 2/2] devtools: added stats print Ciara Power
2020-01-28 15:41 ` Ferruh Yigit
2020-02-22 20:55 ` Thomas Monjalon
2020-05-06 9:55 ` [dpdk-dev] [PATCH v2 0/2] standardize devtools check scripts Ciara Power
2020-05-06 9:55 ` [dpdk-dev] [PATCH v2 1/2] devtools: standardize script arguments Ciara Power
2020-05-24 20:57 ` Thomas Monjalon
2020-05-28 14:37 ` Power, Ciara
2020-05-28 15:03 ` Thomas Monjalon
2020-05-06 9:55 ` [dpdk-dev] [PATCH v2 2/2] devtools: added stats print Ciara Power
2020-06-02 13:53 ` [dpdk-dev] [PATCH v3 0/3] standardize devtools check scripts Ciara Power
2020-06-02 13:53 ` [dpdk-dev] [PATCH v3 1/3] devtools: standardize script arguments Ciara Power
2020-06-17 9:40 ` Thomas Monjalon
2020-06-02 13:53 ` [dpdk-dev] [PATCH v3 2/3] devtools: added stats print Ciara Power
2020-06-02 13:53 ` Ciara Power [this message]
2020-06-03 15:50 ` [dpdk-dev] [PATCH v3 3/3] doc/guides: updated script usage for checking patches Ferruh Yigit
2020-06-17 9:46 ` Thomas Monjalon
2020-06-23 9:29 ` [dpdk-dev] [PATCH v4 0/2] standardize devtools check scripts Ciara Power
2020-06-23 9:29 ` [dpdk-dev] [PATCH v4 1/2] devtools: standardize script arguments Ciara Power
2020-06-23 9:29 ` [dpdk-dev] [PATCH v4 2/2] devtools: added stats print Ciara Power
2020-07-30 22:50 ` Thomas Monjalon
2020-07-30 22:52 ` [dpdk-dev] [PATCH v4 0/2] standardize devtools check scripts Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200602135319.21457-4-ciara.power@intel.com \
--to=ciara.power@intel.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=john.mcnamara@intel.com \
--cc=marko.kovacevic@intel.com \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).