From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id D2787A0A0E; Wed, 3 Feb 2021 13:18:19 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 5F128240524; Wed, 3 Feb 2021 13:18:19 +0100 (CET) Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by mails.dpdk.org (Postfix) with ESMTP id F188E240523 for ; Wed, 3 Feb 2021 13:18:17 +0100 (CET) IronPort-SDR: SduvsVu5Xb5a+8GS+hcdc6DeKUi7Toptams4pUBqEtF6kSEZ/28PNib9RQg1lCwQD2FQyeazas Y/oWnu8kWiPw== X-IronPort-AV: E=McAfee;i="6000,8403,9883"; a="181175690" X-IronPort-AV: E=Sophos;i="5.79,398,1602572400"; d="scan'208";a="181175690" Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orsmga102.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 03 Feb 2021 04:18:16 -0800 IronPort-SDR: 6UAQK5UN4DO9XzXxNfjldkGIIXTJ8jLIxvvKPjZfbynbAieh2tyMlXIATVVYMmF3Z52jJtmohY N1jcvLNCaBVw== X-IronPort-AV: E=Sophos;i="5.79,398,1602572400"; d="scan'208";a="414131938" Received: from bricha3-mobl.ger.corp.intel.com ([10.252.15.14]) by fmsmga002-auth.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-SHA; 03 Feb 2021 04:18:15 -0800 Date: Wed, 3 Feb 2021 12:18:12 +0000 From: Bruce Richardson To: Thomas Monjalon Cc: dev@dpdk.org Message-ID: <20210203121812.GA1708@bricha3-MOBL.ger.corp.intel.com> References: <20210203103057.2821352-1-thomas@monjalon.net> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20210203103057.2821352-1-thomas@monjalon.net> Subject: Re: [dpdk-dev] [PATCH 1/1] doc: explain steps for improved code spell checking X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 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" On Wed, Feb 03, 2021 at 11:30:57AM +0100, Thomas Monjalon wrote: > The script build-dict.sh was added in DPDK 20.08. > It generates a better dictionary for spell checking > done via checkpatch. > > Signed-off-by: Thomas Monjalon > --- > doc/guides/contributing/patches.rst | 10 +++++++--- > 1 file changed, 7 insertions(+), 3 deletions(-) > > diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst > index a7346b4cb1..a27e5731a6 100644 > --- a/doc/guides/contributing/patches.rst > +++ b/doc/guides/contributing/patches.rst > @@ -431,11 +431,15 @@ updating the Linux kernel sources. > The path to the original Linux script must be set in the environment variable ``DPDK_CHECKPATCH_PATH``. > > Spell checking of commonly misspelled words > -can be enabled by downloading the codespell dictionary:: > +can be enabled with the codespell library:: > > - https://raw.githubusercontent.com/codespell-project/codespell/master/codespell_lib/data/dictionary.txt > + git clone https://github.com/codespell-project/codespell.git > Does installing via apt or dnf work as well? If we do install from package do we still need to specify the path to codespell as script parameter? > -The path to the downloaded ``dictionary.txt`` must be set > +There is a DPDK script to build an adjusted dictionary:: > + > + devtools/build-dict.sh codespell/ > codespell-dpdk.txt > + Do we always need to have people build this themselves? Can we create a .codespell-dpdk.txt file in the repo and have that as the default value for the path if the environment variable is not set? > +The path to the dictionary must be set > in the environment variable ``DPDK_CHECKPATCH_CODESPELL``. > > Environment variables required by the development tools, > -- > 2.30.0 >