From: Thomas Monjalon <thomas@monjalon.net>
To: dev@dpdk.org
Cc: bruce.richardson@intel.com, ferruh.yigit@intel.com,
david.marchand@redhat.com
Subject: [dpdk-dev] [PATCH v2] doc: explain steps for improved code spell checking
Date: Fri, 21 May 2021 10:57:49 +0200 [thread overview]
Message-ID: <20210521085749.849907-1-thomas@monjalon.net> (raw)
In-Reply-To: <20210203103057.2821352-1-thomas@monjalon.net>
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 <thomas@monjalon.net>
---
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
next prev parent reply other threads:[~2021-05-21 8:58 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-03 10:30 [dpdk-dev] [PATCH 1/1] " Thomas Monjalon
2021-02-03 12:18 ` Bruce Richardson
2021-02-03 12:53 ` Thomas Monjalon
2021-02-03 13:59 ` Bruce Richardson
2021-02-03 15:53 ` Thomas Monjalon
2021-05-21 8:57 ` Thomas Monjalon [this message]
2021-05-21 9:17 ` [dpdk-dev] [PATCH v2] " David Marchand
2021-05-21 13:49 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210521085749.849907-1-thomas@monjalon.net \
--to=thomas@monjalon.net \
--cc=bruce.richardson@intel.com \
--cc=david.marchand@redhat.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).