FreeRTOS Kernel Spelling Update (#170)

* FreeRTOS Kernel Spelling Update

* Added spell check to kernel repository.
* Fixed small spelling errors in various kernel source files.
* Added documentation for spellcheck.

Note: Only kernel files are checked for spelling, and portable files are ignored.

Author: lundinc2

.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI Checks
+on:
+  push:
+    branches: ["**"]
+  pull_request:
+    branches: [master]
+  workflow_dispatch:
+jobs:
+  spell-check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Parent Repo
+        uses: actions/checkout@v2
+        with:
+          ref: master
+          repository: aws/aws-iot-device-sdk-embedded-C
+          path: main
+      - name: Clone This Repo
+        uses: actions/checkout@v2
+        with:
+            path: ./kernel
+      - name: Install spell
+        run: |
+          sudo apt-get install spell
+          sudo apt-get install util-linux
+      - name: Check spelling
+        run: |
+          PATH=$PATH:main/tools/spell
+          # 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/
+          if [ "$?" = "0" ]; then
+            exit 0
+          else
+            exit 1
+          fi
+

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 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.
+

include/event_groups.h

@@ -670,7 +670,7 @@ EventBits_t xEventGroupSetBits( EventGroupHandle_t xEventGroup,
  *      xEventGroupSync( xEventBits, TASK_1_BIT, ALL_SYNC_BITS, portMAX_DELAY );
  *
  *      // xEventGroupSync() was called with an indefinite block time, so
- *      // this task will only reach here if the syncrhonisation was made by all
+ *      // this task will only reach here if the synchronisation was made by all
  *      // three tasks, so there is no need to test the return value.
  *   }
  * }
@@ -689,7 +689,7 @@ EventBits_t xEventGroupSetBits( EventGroupHandle_t xEventGroup,
  *      xEventGroupSync( xEventBits, TASK_2_BIT, ALL_SYNC_BITS, portMAX_DELAY );
  *
  *      // xEventGroupSync() was called with an indefinite block time, so
- *      // this task will only reach here if the syncrhonisation was made by all
+ *      // this task will only reach here if the synchronisation was made by all
  *      // three tasks, so there is no need to test the return value.
  *  }
  * }

include/queue.h

@@ -1535,7 +1535,7 @@ BaseType_t xQueueGiveMutexRecursive( QueueHandle_t xMutex ) PRIVILEGED_FUNCTION;
 #endif
 
 /*
- * Generic version of the function used to creaet a queue using dynamic memory
+ * Generic version of the function used to create a queue using dynamic memory
  * allocation.  This is called by other functions and macros that create other
  * RTOS objects that use the queue structure as their base.
  */
@@ -1546,7 +1546,7 @@ BaseType_t xQueueGiveMutexRecursive( QueueHandle_t xMutex ) PRIVILEGED_FUNCTION;
 #endif
 
 /*
- * Generic version of the function used to creaet a queue using dynamic memory
+ * Generic version of the function used to create a queue using dynamic memory
  * allocation.  This is called by other functions and macros that create other
  * RTOS objects that use the queue structure as their base.
  */

include/task.h

@@ -3023,7 +3023,7 @@ eSleepModeStatus eTaskConfirmSleepModeStatus( void ) PRIVILEGED_FUNCTION;
 TaskHandle_t pvTaskIncrementMutexHeldCount( void ) PRIVILEGED_FUNCTION;
 
 /*
- * For internal use only.  Same as vTaskSetTimeOutState(), but without a critial
+ * For internal use only.  Same as vTaskSetTimeOutState(), but without a critical
  * section.
  */
 void vTaskInternalSetTimeOutState( TimeOut_t * const pxTimeOut ) PRIVILEGED_FUNCTION;