* [dpdk-dev] [PATCH] doc: add info about codespell config
@ 2019-11-20 13:27 Kevin Traynor
2019-11-28 0:07 ` Thomas Monjalon
0 siblings, 1 reply; 2+ messages in thread
From: Kevin Traynor @ 2019-11-20 13:27 UTC (permalink / raw)
To: dev, john.mcnamara, marko.kovacevic; +Cc: david.marchand, Kevin Traynor
Document the config to use codespell with checkpatches.sh.
Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
---
doc/guides/contributing/patches.rst | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)
diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index 214030346..0f1333471 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -408,6 +408,13 @@ updating the Linux kernel sources.
The path to the original Linux script must be set in the environment variable ``DPDK_CHECKPATCH_PATH``.
-This, and any other configuration variables required by the development tools, are loaded from the following
-files, in order of preference::
+
+Spell checking of commonly misspelled words can be enabled by downloading the codespell dictionary::
+
+ curl -o ~/dictionary.txt https://raw.githubusercontent.com/codespell-project/codespell/master/codespell_lib/data/dictionary.txt
+
+The path to the downloaded ``dictionary.txt`` must be set in the environment variable ``DPDK_CHECKPATCH_CODESPELL``.
+
+Environment variables required by the development tools, are loaded from the following files,
+in order of preference::
.develconfig
--
2.21.0
^ permalink raw reply [flat|nested] 2+ messages in thread* Re: [dpdk-dev] [PATCH] doc: add info about codespell config
2019-11-20 13:27 [dpdk-dev] [PATCH] doc: add info about codespell config Kevin Traynor
@ 2019-11-28 0:07 ` Thomas Monjalon
0 siblings, 0 replies; 2+ messages in thread
From: Thomas Monjalon @ 2019-11-28 0:07 UTC (permalink / raw)
To: Kevin Traynor; +Cc: dev, john.mcnamara, marko.kovacevic, david.marchand
20/11/2019 14:27, Kevin Traynor:
> Document the config to use codespell with checkpatches.sh.
>
> Signed-off-by: Kevin Traynor <ktraynor@redhat.com>
> ---
> --- a/doc/guides/contributing/patches.rst
> +++ b/doc/guides/contributing/patches.rst
> -This, and any other configuration variables required by the development tools, are loaded from the following
> -files, in order of preference::
> +
> +Spell checking of commonly misspelled words can be enabled by downloading the codespell dictionary::
> +
> + curl -o ~/dictionary.txt https://raw.githubusercontent.com/codespell-project/codespell/master/codespell_lib/data/dictionary.txt
curl command is unneeded here
> +
> +The path to the downloaded ``dictionary.txt`` must be set in the environment variable ``DPDK_CHECKPATCH_CODESPELL``.
> +
> +Environment variables required by the development tools, are loaded from the following files,
> +in order of preference::
Applied with minor changes, thanks
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2019-11-28 0:07 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-11-20 13:27 [dpdk-dev] [PATCH] doc: add info about codespell config Kevin Traynor
2019-11-28 0:07 ` Thomas Monjalon
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).