DPDK-dev Archive on lore.kernel.org
 help / color / Atom feed
* [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, back to index

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

DPDK-dev Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/dpdk-dev/0 dpdk-dev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 dpdk-dev dpdk-dev/ https://lore.kernel.org/dpdk-dev \
		dev@dpdk.org
	public-inbox-index dpdk-dev

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.dpdk.dev


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git