diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e36ae8160..f6b62a985 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -26,7 +26,6 @@ jobs: - name: Check spelling run: | PATH=$PATH:main/tools/spell - ls kernel # Make sure that the portable directory is not included in the spellcheck. sed -i 's/find $DIRNAME/find $DIRNAME -not -path '*portable*'/g' main/tools/spell/find-unknown-comment-words find-unknown-comment-words --directory kernel/ diff --git a/README.md b/README.md index 529509aac..1cc1b84ce 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,6 @@ See the readme file in the ```./portable``` directory for more information. FreeRTOS files are formatted using the "uncrustify" tool. The configuration file used by uncrustify can be found in the [FreeRTOS/FreeRTOS repository](https://github.com/FreeRTOS/FreeRTOS/blob/master/tools/uncrustify.cfg). ### Spelling -*lexicon.txt* contains words that are not traditionally found in an English dictionary. It is used by the spellchecker to verify the various jargon, variable names, and other odd words used in the FreeRTOS code base. If your pull request fails to pass the spelling check fix the error. If it is a variable name or the like that IS spelled correctly, but unknown to the lexicon, then add the word to *lexicon.txt*. +*lexicon.txt* contains words that are not traditionally found in an English dictionary. It is used by the spellchecker to verify the various jargon, variable names, and other odd words used in the FreeRTOS code base. If your pull request fails to pass the spelling and you believe this is a mistake, then add the word to *lexicon.txt*. Note that only the FreeRTOS Kernel source files are checked for proper spelling, the portable section is ignored.