From patchwork Tue Jun 2 13:53:19 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Power, Ciara" X-Patchwork-Id: 70738 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 206CBA0513; Tue, 2 Jun 2020 15:58:14 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id C11C01BF76; Tue, 2 Jun 2020 15:57:58 +0200 (CEST) Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by dpdk.org (Postfix) with ESMTP id 424A41BF59 for ; Tue, 2 Jun 2020 15:57:57 +0200 (CEST) IronPort-SDR: Boge60YdQv3YOK07jGDl9S3m6vyOi3bteGUzfxJnGxvtDkvnNEr5k6JpX+YtrjZwwOgA2HH0PE W8Diy/otAOrQ== X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga001.jf.intel.com ([10.7.209.18]) by fmsmga105.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 02 Jun 2020 06:57:43 -0700 IronPort-SDR: xENVSzdF8GmCAMFMejJ8xgoFHG6mryYECv72fhZWn2jXq/+c/QlDjh9xqoidfnMjX9O2vdcZwu 50Ei6WAXaBJA== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.73,464,1583222400"; d="scan'208";a="347406316" Received: from silpixa00399953.ir.intel.com (HELO silpixa00399953.ger.corp.intel.com) ([10.237.222.53]) by orsmga001.jf.intel.com with ESMTP; 02 Jun 2020 06:57:42 -0700 From: Ciara Power To: thomas@monjalon.net, john.mcnamara@intel.com, marko.kovacevic@intel.com Cc: ferruh.yigit@intel.com, dev@dpdk.org, Ciara Power Date: Tue, 2 Jun 2020 14:53:19 +0100 Message-Id: <20200602135319.21457-4-ciara.power@intel.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20200602135319.21457-1-ciara.power@intel.com> References: <20200128150256.14339-1-ciara.power@intel.com> <20200602135319.21457-1-ciara.power@intel.com> Subject: [dpdk-dev] [PATCH v3 3/3] doc/guides: updated script usage for checking patches 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" 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 Acked-by: Ferruh Yigit --- 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: