From: Bruce Richardson <bruce.richardson@intel.com>
To: Thomas Monjalon <thomas@monjalon.net>
Cc: dev@dpdk.org
Subject: Re: [dpdk-dev] [PATCH 1/1] doc: explain steps for improved code spell checking
Date: Wed, 3 Feb 2021 12:18:12 +0000 [thread overview]
Message-ID: <20210203121812.GA1708@bricha3-MOBL.ger.corp.intel.com> (raw)
In-Reply-To: <20210203103057.2821352-1-thomas@monjalon.net>
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 <thomas@monjalon.net>
> ---
> 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
>
next prev parent reply other threads:[~2021-02-03 12:18 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-03 10:30 Thomas Monjalon
2021-02-03 12:18 ` Bruce Richardson [this message]
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 ` [dpdk-dev] [PATCH v2] " Thomas Monjalon
2021-05-21 9:17 ` 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=20210203121812.GA1708@bricha3-MOBL.ger.corp.intel.com \
--to=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
--cc=thomas@monjalon.net \
/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).