From 252409e0be65c6f89b3b430555293fcae9b182b4 Mon Sep 17 00:00:00 2001 From: Carl Lundin Date: Tue, 15 Sep 2020 09:27:35 -0700 Subject: [PATCH] Added documentation for spellcheck. --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 173e1a6ff..529509aac 100644 --- a/README.md +++ b/README.md @@ -33,3 +33,7 @@ See the readme file in the ```./portable``` directory for more information. ### Code Formatting 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*. +Note that only the FreeRTOS Kernel source files are checked for proper spelling, the portable section is ignored. +