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 CFE26A0A02; Fri, 21 May 2021 10:58:02 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 85F8640143; Fri, 21 May 2021 10:58:02 +0200 (CEST) Received: from wout4-smtp.messagingengine.com (wout4-smtp.messagingengine.com [64.147.123.20]) by mails.dpdk.org (Postfix) with ESMTP id 95AFC40041 for ; Fri, 21 May 2021 10:58:01 +0200 (CEST) Received: from compute5.internal (compute5.nyi.internal [10.202.2.45]) by mailout.west.internal (Postfix) with ESMTP id 29E701323; Fri, 21 May 2021 04:58:00 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute5.internal (MEProxy); Fri, 21 May 2021 04:58:00 -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; s=fm1; bh=fk0C2nbW1vfj1 CI+aUZi01PM6R8yITc01idqZy3K3po=; b=rntsiY6MVA3CQzwGJidU3YrRBFbPM u9ucWtt66sWloZBVK11G6jAwo/mI4tGzGyQpBwwFh1N3IqoK5NPN1TPEDaZ+fyzw OEkEPHhGwVxnYgwYYrrfvdC8upBa6w6RMjncn2jxqeVQlVusr5HdVAmyrqxMbHo3 id+lJh8F4WQl5sqIuJXT26CVGd2XM8ROUfW46C7X+Ipie4+k1y3FHrp7K+Q//RbQ fn6skpkFIqCcPhlHZXfWEp46gvMF2Xb9BB3tXOHsJpKZ8/5nF6pGV6nHZqOntdtL JDgAartDPjQDgYqc15qWLw8BmogwGHPmdG++Bk7q8oZUlN/cj2WCgMu/w== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding: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= fm2; bh=fk0C2nbW1vfj1CI+aUZi01PM6R8yITc01idqZy3K3po=; b=LaAvGFSx m+UJVnY5YGcDuUETQDSMtT+eU3BsrT7Sp+4TguHfJVKUsfWJdpo/j7KkqPnpqvLf tjsDr4CVbqKfxWShnS65AqNeUchdBrzw9F8QZ6ynJ8axcZV4dPJITlGoSCzmswnO WcCkQNORXTRrsMQ9e7fzKhQDgjpDxLetZP1KC9LJsImyd5fNd4KAq3KTGHehTzZi Ilsfe2jZ/TKEJhlqAecrpLVTFjv4cvDbo5CDvkvsQdSwV70v7PvvhhdTav+ihtuu i4uhtRB+pBacYIdV3+Ji3kfADwp9Dt5bQfF/pyb8tgdWVToRGbti2aW8D4uZvSjH fMlAp3fnUQx7MA== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduledrvdejfedguddtucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucenucfjughrpefhvffufffkofgjfhgggfestdekre dtredttdenucfhrhhomhepvfhhohhmrghsucfoohhnjhgrlhhonhcuoehthhhomhgrshes mhhonhhjrghlohhnrdhnvghtqeenucggtffrrghtthgvrhhnpefggfeliedutefhteffte euffeghfdtvddvjedvteelffehjeffffehgeelueffvdenucffohhmrghinhepghhithhh uhgsuhhsvghrtghonhhtvghnthdrtghomhdpghhithhhuhgsrdgtohhmnecukfhppeejje drudefgedrvddtfedrudekgeenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhep mhgrihhlfhhrohhmpehthhhomhgrshesmhhonhhjrghlohhnrdhnvght X-ME-Proxy: Received: from xps.monjalon.net (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA; Fri, 21 May 2021 04:57:58 -0400 (EDT) From: Thomas Monjalon To: dev@dpdk.org Cc: bruce.richardson@intel.com, ferruh.yigit@intel.com, david.marchand@redhat.com Date: Fri, 21 May 2021 10:57:49 +0200 Message-Id: <20210521085749.849907-1-thomas@monjalon.net> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210203103057.2821352-1-thomas@monjalon.net> References: <20210203103057.2821352-1-thomas@monjalon.net> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v2] 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" 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 --- v2: explain the default --- doc/guides/contributing/patches.rst | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst index 6dbbd5f8d1..b9cc6e67ae 100644 --- a/doc/guides/contributing/patches.rst +++ b/doc/guides/contributing/patches.rst @@ -430,14 +430,17 @@ 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:: - - https://raw.githubusercontent.com/codespell-project/codespell/master/codespell_lib/data/dictionary.txt - -The path to the downloaded ``dictionary.txt`` must be set +Spell checking of commonly misspelled words is enabled +by default if installed in ``/usr/share/codespell/dictionary.txt``. +A different dictionary path can be specified in the environment variable ``DPDK_CHECKPATCH_CODESPELL``. +There is a DPDK script to build an adjusted dictionary +from the multiple codespell dictionaries:: + + git clone https://github.com/codespell-project/codespell.git + devtools/build-dict.sh codespell/ > codespell-dpdk.txt + Environment variables required by the development tools, are loaded from the following files, in order of preference:: -- 2.31.1