From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 7B4EAA04A5; Wed, 17 Jun 2020 11:46:54 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 134392BF4; Wed, 17 Jun 2020 11:46:54 +0200 (CEST) Received: from out5-smtp.messagingengine.com (out5-smtp.messagingengine.com [66.111.4.29]) by dpdk.org (Postfix) with ESMTP id 5C5D429C6 for ; Wed, 17 Jun 2020 11:46:52 +0200 (CEST) Received: from compute7.internal (compute7.nyi.internal [10.202.2.47]) by mailout.nyi.internal (Postfix) with ESMTP id 0BF3F5C0048; Wed, 17 Jun 2020 05:46:52 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute7.internal (MEProxy); Wed, 17 Jun 2020 05:46:52 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding:content-type; s=fm1; bh= w2TUnCdy7tV7w2Y7xaXHNJGd6GGH4WQkAS5KpxH6teU=; b=k7EkpZEW6Htl1URR 2hE0KRXrObEv62jyyzmsWPr3DyX9hYzV6JU7K5gz/rpaT2MTspEnRKu+0OhWs5p9 vxLR4XoNM8X2uxfhJyiJBc7eTcZcMgLXrGTu8gtiXso7qdNH1NiRqBCc+S7OahKz Sbgmc71cSxborbx1J3MEZKvUwhDUAKHcHK2L+vrTl41b6GmnsXTL1Eo7eqBYog+W 4jm4u6V/sSnP3eJUo/s+YNqIZ8tF0twzeBV9hW0qvrzt5AxDJ8flHoSpyNWLzh6Q ac+tjjNQpWh08ZCHvimuxl926oIxHQCTvtdWIHq33svedDa93ncJ2Mlw7/bb/1tR ZWz+dg== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:from:in-reply-to:message-id:mime-version:references :subject:to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender :x-sasl-enc; s=fm3; bh=w2TUnCdy7tV7w2Y7xaXHNJGd6GGH4WQkAS5KpxH6t eU=; b=ihMxx9BOILVRxkFYfdiAiQG7bd206U32Y8ZcW0/jKWr1PBHH/LLqYtIF7 xeUF5NvPM3kyjh0rBkxGJP41XAHxy8dGCVrIcdCiM78bVsUIW4IPi8eSmtLl5By1 CVRohoD23MDR9DcTSR7a4sjQsLcVytJz4ix4HuiHNFkuUsbu7s3n2nEv6HaWCjJC 5McdMKv7yfF/lq7itxoEnG3dIKN6HOSXpp2VD40dKoyD8M2CH6jBEaBygOW4tjy7 +Ieas2HNRH2TDfv92X/PyASR697wS12AgpzjvYtEumKxTl9bLynuTmfiUOlifoaA 5GzAfnfkLsmFcjfv1QbQI/BUKsBog== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduhedrudejvddgvddtucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhephffvufffkfgjfhgggfgtsehtufertddttddvnecuhfhrohhmpefvhhhomhgr shcuofhonhhjrghlohhnuceothhhohhmrghssehmohhnjhgrlhhonhdrnhgvtheqnecugg ftrfgrthhtvghrnhepudeggfdvfeduffdtfeeglefghfeukefgfffhueejtdetuedtjeeu ieeivdffgeehnecukfhppeejjedrudefgedrvddtfedrudekgeenucevlhhushhtvghruf hiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhrohhmpehthhhomhgrshesmhhonhhjrghl ohhnrdhnvght X-ME-Proxy: Received: from xps.localnet (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id BAAB03280064; Wed, 17 Jun 2020 05:46:49 -0400 (EDT) From: Thomas Monjalon To: john.mcnamara@intel.com, Ciara Power Cc: marko.kovacevic@intel.com, dev@dpdk.org, ferruh.yigit@intel.com Date: Wed, 17 Jun 2020 11:46:47 +0200 Message-ID: <1926699.qq3n9OSdOt@thomas> In-Reply-To: <20200602135319.21457-4-ciara.power@intel.com> References: <20200128150256.14339-1-ciara.power@intel.com> <20200602135319.21457-1-ciara.power@intel.com> <20200602135319.21457-4-ciara.power@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" Subject: Re: [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" 02/06/2020 15:53, Ciara Power: > 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. I think the doc update should be merged in the first patch. In general, doc and code updates should come together. [...] > 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. This is repeating what we get with the -h option. I would suggest dropping the options explanation from this guide. > > 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. Same here, it is repeating what is documented with using -h. If we really want to give an indication, we can say once for both that the -n option is a number of commits from HEAD, and -r option is a "git log" range. A single sentence is probably enough. In general, if we want guides to be read, they must be short. John, as the doc owner, do you agree?