| Message ID | 20191120132713.28197-1-ktraynor@redhat.com (mailing list archive) |
|---|---|
| State | Accepted, archived |
| Delegated to: | Thomas Monjalon |
| Headers | show |
| Series | doc: add info about codespell config | expand |
| Context | Check | Description |
|---|---|---|
| ci/Intel-compilation | fail | Compilation issues |
| ci/travis-robot | success | Travis build: passed |
| ci/checkpatch | success | coding style OK |
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
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
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(-)