From patchwork Wed Feb 3 10:30:57 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Monjalon X-Patchwork-Id: 87676 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id E04F7A0A0E; Wed, 3 Feb 2021 11:31:48 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id C73D52404D4; Wed, 3 Feb 2021 11:31:48 +0100 (CET) Received: from out5-smtp.messagingengine.com (out5-smtp.messagingengine.com [66.111.4.29]) by mails.dpdk.org (Postfix) with ESMTP id 907CA2404D0 for ; Wed, 3 Feb 2021 11:31:47 +0100 (CET) Received: from compute2.internal (compute2.nyi.internal [10.202.2.42]) by mailout.nyi.internal (Postfix) with ESMTP id 321E45C01F6; Wed, 3 Feb 2021 05:31:47 -0500 (EST) Received: from mailfrontend2 ([10.202.2.163]) by compute2.internal (MEProxy); Wed, 03 Feb 2021 05:31:47 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= from:to:subject:date:message-id:mime-version :content-transfer-encoding; s=fm3; bh=BxB3vgFbzEPxRouBbi2+sWW/cG l8lkOr/9Tci/IoPi8=; b=F3nOy84+iM7uPiPzZ/+o4cBhoQQ2qwr7gDGKsA8ffm F8JFxdmjvQuWE2g2VMHVAcF9RUQXZy2kGfvFdnGbS8ktEC5fAnQQmhrg/xp/g/xq GxAqc3YqudQLa0AnPOAryk5iw3UVAbyzVXJT3mPaBtyVsdN6uEeFMsEh5UexGEkq KQwGn2HSN66mlQx/cyV1+Dl2XQUzbLa8Gn2ZEI8aG2fzlQRJ9CkSyyYTOGGlpHky yRE9W3YPinyfV0DCqsNMeeOpLIlu2h4ilLmb2+jgksvrfKx4m/WT/TldOFxb0REx he5ykYfxvWT8DGi8E61ebWToPjiMhyhSYSJh3yLqBUbQ== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=content-transfer-encoding:date:from :message-id:mime-version:subject:to:x-me-proxy:x-me-proxy :x-me-sender:x-me-sender:x-sasl-enc; s=fm2; bh=BxB3vgFbzEPxRouBb i2+sWW/cGl8lkOr/9Tci/IoPi8=; b=W2x00sF/FHIz5fWaglACHfj7zLpkfCEys r23jBZuy5+OHxxowsN2mwM/ILEsenjxxioWaBsMrk5lOd1wkcnPtrkCtp1nQAy5u CVb1IYFRbIC7z/BjwpBKz8fnMOCM4o6x7PWfKeJdzuOzEHKG6zj4r87Qp1o+xTAb 2LGABPihzG8bHdcQCmRujMBsmgl0qvponKQm1d7hubnhrJ9tvEcm9gfPjW7wCMZF PnWB44wnJFJmbsArg1fCTtra31dMQrgdphFWrhRD4/OX3PkAd1Cdp2SrP51v3h4q qA6G3dPGKuJkKZ+GTvieZPfkFHzhVFCuH8xjpGp7tDmetWHb/oQBg== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduledrgedvgdduiecutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecunecujfgurhephffvufffkffoggfgsedtkeertdertd dtnecuhfhrohhmpefvhhhomhgrshcuofhonhhjrghlohhnuceothhhohhmrghssehmohhn jhgrlhhonhdrnhgvtheqnecuggftrfgrthhtvghrnhepudeuueeiteeitdffieffjeeite elkeejkeeiieehvdegfeefhfdugeevhfegudfhnecuffhomhgrihhnpehgihhthhhusghu shgvrhgtohhnthgvnhhtrdgtohhmpdhgihhthhhusgdrtghomhenucfkphepjeejrddufe egrddvtdefrddukeegnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehmrghi lhhfrhhomhepthhhohhmrghssehmohhnjhgrlhhonhdrnhgvth 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 id A71C31080066 for ; Wed, 3 Feb 2021 05:31:46 -0500 (EST) From: Thomas Monjalon To: dev@dpdk.org Date: Wed, 3 Feb 2021 11:30:57 +0100 Message-Id: <20210203103057.2821352-1-thomas@monjalon.net> X-Mailer: git-send-email 2.30.0 MIME-Version: 1.0 Subject: [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" 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 -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 + +The path to the dictionary must be set in the environment variable ``DPDK_CHECKPATCH_CODESPELL``. Environment variables required by the development tools,