Merge pull request nasa#1915 from thnkslprpt/FIX-CFE-TYPOS

Fixed various typos in docs, comments and error messages.

Part of nasa/cFS#352

.github/workflows/functional-tests.yml

@@ -79,7 +79,7 @@ jobs:
             temp=$(grep -c "BEGIN" cf/cfe_test.tmp) 
               
             if [ $temp -eq $counter ]; then
-              echo "Test is frozen. Quiting"
+              echo "Test is frozen. Quitting"
               break
             fi
 

CMakeLists.txt

@@ -28,13 +28,13 @@
 #
 # prepare:
 #   Use the information in the target config to set up additional variables
-#   and satisfy any preequisites for targets.  Most importantly this stage
-#   is reposible for finding the actual location of all source files for apps
+#   and satisfy any prerequisites for targets.  Most importantly this stage
+#   is responsible for finding the actual location of all source files for apps
 #   listed in the mission configuration, along with collecting any supplemental
 #   sources, such as EDS files or additional compiler flags.
 #
 # process_arch:
-#   This is called multiple times, once for each CPU architecture specfied in
+#   This is called multiple times, once for each CPU architecture specified in
 #   the main targets.cmake file.  At the mission level, this creates a sub
 #   project target using the correct toolchain for cross compile.  In the arch
 #   specific level (inside the sub-project) it generates the actual library and

README.md

@@ -225,7 +225,7 @@ The detailed cFE user's guide can be viewed at <https://github.com/nasa/cFS/blob
 
 - Uses `int` with %d conversions inUtAssert_True and UtPrintf for platform portability.
 - Specifying the special string NULL as the entry point in a startup script results in no entry point being called for the library. Equivalent to leaving the field empty.
-- [build system] Adds a hook for an `install_custom.cmake` script that can added to a CPU-specific subdirectory under the "defs" directory. This hook can perform extra installation steps for custom implementations. Tweaks the `add_cfe_tables` function so it can be called from the `install_custom.cmake` script to generate additional table binaries for that CPU.
+- [build system] Adds a hook for an `install_custom.cmake` script that can be added to a CPU-specific subdirectory under the "defs" directory. This hook can perform extra installation steps for custom implementations. Tweaks the `add_cfe_tables` function so it can be called from the `install_custom.cmake` script to generate additional table binaries for that CPU.
 - [build system] `add_cfe_tables` now uses the "APP_NAME" parameter to associate the table files with the app library, so the same set of include files can be used. Still allows any unique string to be used as "APP_NAME" for backward compatibility. The script will now generate a "Note" message to the user if it does not match an application name.
 - If the multiple table feature is used, it actually needs to match the application name, or else the include paths may be incomplete.
 - Removes discrepancies (return type, parameter names, etc) between function prototypes and implementation. Also fixes some but not all use of CFE_Status_t in the implementations. Updates ut-stubs accordingly.
@@ -234,7 +234,7 @@ The detailed cFE user's guide can be viewed at <https://github.com/nasa/cFS/blob
 
 ### Development Build: v6.8.0-rc1+dev580
 
-- Adds `CFE_MSG_GetNextSequenceCount` so the auto-increment of the local sequence counter works when sending tlm (and increment is enabled). Updates unit tests and adds the old-style stub. The unit tests check for the correct rollover behavior.Sequence count will roll over based on the mask. Before the fix the sequence counter would "stick" in telemetry until the passed in value rolled over.
+- Adds `CFE_MSG_GetNextSequenceCount` so the auto-increment of the local sequence counter works when sending tlm (and increment is enabled). Updates unit tests and adds the old-style stub. The unit tests check for the correct rollover behavior. Sequence count will roll over based on the mask. Before the fix the sequence counter would "stick" in telemetry until the passed in value rolled over.
 - [docs] Correctly format code block section terminator so Markdown renders correctly
 - [docs] Fix typos in developer guide
 - See <https://github.com/nasa/cFE/pull/1508> and <https://github.com/nasa/cFS/pull/259>
@@ -266,7 +266,7 @@ a default handler routine.
 Updates the doxygen documentation for this parameter, as it was incorrectly specifying a 32-bit alignment requirement.
 - Adds new functional tests for ES Child Task API. Does not check edge cases. Fixed spelling mistake in `UtAssert_ResourceID_Undifeined` name
 - Removes BUILDDIR reference and an old comment. No behavior changes
-- Moves and renames `cfe_resourceid_basevalue.h` to `cfe_resourceid_basevalue.h`. Since it is is assumed/required that resource IDs follow the "osal compatible" pattern. Perhaps in a future version this could change, but
+- Moves and renames `cfe_resourceid_basevalue.h` to `cfe_resourceid_basevalue.h`. Since it is assumed/required that resource IDs follow the "osal compatible" pattern. Perhaps in a future version this could change, but
 - Ensures that the `CFE_SUCCESS` constant is of the `CFE_Status_t` type. Since an explicit cast is required on all error codes that are expected to be negative values.
 - Removes unused error codes: `CFE_ES_ERR_SHELL_CMD` and `CFE_SB_NO_MSG_RECV`. No impact to behavior.
 - When a startup file has a line with too many tokens the build script will generate a concise warning including an indicator of which line is causing the problem.
@@ -276,7 +276,7 @@ Updates the doxygen documentation for this parameter, as it was incorrectly spec
 - `CFE_ES_GenPoolInitialize` now returns ` CFE_ES_BAD_ARGUMENT` error if the `AlignSize` passed-in value is not actually a power of two instead of "fixing" the alignment mask,
 - Replace internal `CFE_ES_SYSLOG_APPEND` macro with the `CFE_ES_WriteToSysLog()` API since coding standards discourage use of multi-line macros.
 - [docs] Improve Resource IDs documentation. Specifically on use of the various helper functions and common patterns Documents that the "IsMatch()" functions accept NULL pointers so they can be used with initial validation (gatekeeper). All other helper functions assume a non-NULL pointer.
-- Compiler will catch if the `CFE_RESOURCEID_MAX` value changes in such a way that makes it not usable as a bit mask as intended. Add a compile time assert to ensure that `CFE_RESOURCEID_MAX` value is one less than a power of two  (i.e. an LSB-justified bit mask). Notes in the comments that it serves as both a numeric limit and a mask.
+- Compiler will catch if the `CFE_RESOURCEID_MAX` value changes in such a way that makes it not usable as a bit mask as intended. Add a compile time assert to ensure that `CFE_RESOURCEID_MAX` value is one less than a power of two (i.e. an LSB-justified bit mask). Notes in the comments that it serves as both a numeric limit and a mask.
 - See <https://github.com/nasa/cFE/pull/1431> and <https://github.com/nasa/cFS/pull/250>
 
 
@@ -367,7 +367,7 @@ Updates the doxygen documentation for this parameter, as it was incorrectly spec
 
 ### Development Build: v6.8.0-rc1+dev382
 
-- Refactors the SB buffer descriptor object `CFE_SB_BufferD_t` and simplify the zero-copy buffer paradigm. Combines the zero-copy and the normal CFE buffer descriptor into a single unified `CFE_SB_BufferD_t` object. Results in a simpler zero-copy design that is similarto the the standard, non-zero-copy message path. All message descriptor objects are now tracked in a list by SB. All changes are internal to SB. This does not affect API or behavior of any existing APIs (but see note). Corrects a minor issue where the `MsgSendErrorCounter` would get incremented if there were no subscribers, but only in the zero copy API.  
+- Refactors the SB buffer descriptor object `CFE_SB_BufferD_t` and simplify the zero-copy buffer paradigm. Combines the zero-copy and the normal CFE buffer descriptor into a single unified `CFE_SB_BufferD_t` object. Results in a simpler zero-copy design that is similar to the standard, non-zero-copy message path. All message descriptor objects are now tracked in a list by SB. All changes are internal to SB. This does not affect API or behavior of any existing APIs (but see note). Corrects a minor issue where the `MsgSendErrorCounter` would get incremented if there were no subscribers, but only in the zero copy API.  
 - Replaces `int_32` with `CFE_Status_t` for all error message codes  
 - Removes references to `cfeesugshellsrv` from user guide
 - Adds null pointer checks and size checks to validate method parameters. Returning the input instead of an error code
@@ -396,7 +396,7 @@ Updates the doxygen documentation for this parameter, as it was incorrectly spec
 
 ### Development Build: v6.8.0-rc1+dev348
 
-- Corrects reference to PSP header file location. Build now succesfully completes the build succeeds again when using `add_psp_module()` in custom CMakeLists file.
+- Corrects reference to PSP header file location. Build now successfully completes the build succeeds again when using `add_psp_module()` in custom CMakeLists file.
 - Replace "send" with "write" in names for commands that write files. For example, `CFE_SB_**SEND**_ROUTING_INFO_CC` is now `CFE_SB_**WRITE**_ROUTING_INFO_CC`. Updates function names, command code names and comments.
 - Removes incorrectly implemented deferred return code of `-1` for `CFE_SB_ReceiveBuffer` from software bus setup in `UT_InitData`.
 - Implements more informative **assert messages** by making `SETUP, TEARDOWN, ASSERT` print `0x%lx` while `ASSERT_EQ` now prints both `%lf` and `0x%lx` format for the inputs
@@ -417,7 +417,7 @@ Updates the doxygen documentation for this parameter, as it was incorrectly spec
 - Removes the remnants of the table service exclusion logic and documentation: `EXCLUDE_CFE_TBL` no longer available, even if defined, table services will still start.
 - Set ES and EVS pipe message limit to defaults as opposed to the custom, unjustified, `CFE_SB_SubscribeEx`. This change might queue additional HK messages, but SCH loads after ES anyways.
 - Replaces `CFE_SB_Default_Qos` with `CFE_SB_DEFAULT_QOS` macro that avoids global variable exposure. Removes SB-internal defines that are not implemented nor used.
-- Explicity `memset` the task data to zero at the start of EarlyInit. Standardize the global typdef/variable names.
+- Explicitly `memset` the task data to zero at the start of EarlyInit. Standardize the global typedef/variable names.
 - Moves all functions, macros, types, and other definitions related to resource IDs and generic resource management into a separate module, like `CFE MSG`, `SBR`, etc. This allows a mission to elect "strict" implementations of these objects, where every ID type is unique, and assigning between them or `uint32` results in a compiler error. **API now has separate types for each resource type (Apps, Tasks, Libs, Counters, etc).** The user can elect at the mission level whether this is a simple typedef (all uint32, all interchangeable) or a wrapper type (separate/strict type, cannot be interchanged). The former is backward compatible but the latter is not - must use proper types.
 - Adds Code QL analysis to continuous integration workflow.
 - See <https://github.com/nasa/cFE/pull/1150>
@@ -437,7 +437,7 @@ Updates the doxygen documentation for this parameter, as it was incorrectly spec
 - For primary-only header config: telemetry header required to 64 bit boundary (affects all receivers)
 - For primary and extended header config: command header required padding to 64 bit boundary (affects all senders)
 - Refactor `CFE_TIME_RegisterSynchCallback` to only have one return point and eliminates "possible uninitialized variable" static analysis warning
-- None of these changes are expected to cause problematic.
+- None of these changes are expected to be problematic.
 - Addresses message delivery issues due to inconsistent locking by reworking cFE-SB API implementation. Ensures all events are generated and counters are incremented consistently by avoiding early returns in functions and using the `PendingEventID` register to record what event ID should be sent per the current operation.
 - Employs the `CFE_ES_ResourceID_t` type and related patterns for managing the SB Pipe IDs.
 - Will break code which directly accessed these items without going through the lookup function.
@@ -476,7 +476,7 @@ Updates the doxygen documentation for this parameter, as it was incorrectly spec
 
 - Remove use of `osapi-os-loader.h` from ES UT.
 - Use volatile `sig_atomic_t` for system state to avoid race issue if uint32 isn't atomic on a system
-- Set the flags parameter on the OS_ModuleLoad() properly to allow an app to be properly unloaded, which in turn allows the reload command to work as expected. Fixes problem where unload comand resulted in continuous restarting of the same app code.
+- Set the flags parameter on the OS_ModuleLoad() properly to allow an app to be properly unloaded, which in turn allows the reload command to work as expected. Fixes problem where unload command resulted in continuous restarting of the same app code.
 - Replaced `Test_MSG_PrintMsg` with `UT_DisplayPkt`. Also removed unused `Test_MSG_Sum`.
 - See <https://github.com/nasa/cFE/pull/1047>
 
@@ -487,7 +487,7 @@ Updates the doxygen documentation for this parameter, as it was incorrectly spec
   - Deprecates multiple `CFE_SB_*` items
   - Redefines `CFE_MSG_Size_t` as `size_t` to minimize duplicated work and facilitate transition to `size_t`
 - Use a generic void* as the interface type for the pool buffer pointers. This reduces the need for local type casting in the apps and makes it generally easier to use.
-- Remove  reference to CEXP in RTEMS 4.11 i686 toolchain. Add an RTEMS 5.1 i686 toolchain file.
+- Remove reference to CEXP in RTEMS 4.11 i686 toolchain. Add an RTEMS 5.1 i686 toolchain file.
 - See <https://github.com/nasa/cFE/pull/1045>
 
 
@@ -630,7 +630,7 @@ of the OSAL limit. Task name shows up as `ES_BG_TASK`
 ### Development Build: v6.8.0-rc1+dev13
 
 - Deprecates `CFE_SB_GetLastSenderId()` API by introducing new `CFE_OMIT_DEPRECATED_6_8` tag
-- Documentation update remove deleted requiremements
+- Documentation update remove deleted requirements
 - Add a new *cfe_assert* module for functional testing by making it possible to load the UT assert object code as a CFE library. These are compiled as separate, independent modules and only loaded on demand. Also includes a draft example for cFE testing, which calls some basic ES AppId functions.
 - See <https://github.com/nasa/cFE/pull/816>
 

SECURITY.md

@@ -6,7 +6,7 @@ To report a vulnerability for the cFE subsystem please [submit an issue](https:/
 
 For general cFS vulnerabilities please [open a cFS framework issue](https://github.com/nasa/cfs/issues/new/choose) and see our [top-level security policy](https://github.com/nasa/cFS/security/policy) for additional information.
 
-In either case please use the "Bug Report" template and provide as much information as possible. Apply appropraite labels for each report. For security related reports, tag the issue with the "security" label.
+In either case please use the "Bug Report" template and provide as much information as possible. Apply appropriate labels for each report. For security related reports, tag the issue with the "security" label.
 
 ## Testing
 

cmake/Makefile.sample

@@ -98,7 +98,7 @@ $(FILETGTS):
 	$(MAKE) -C $(O)/$(ARCH) $(@)
 endif
 
-# The "prep" step requires extra options that are specified via enviroment variables.
+# The "prep" step requires extra options that are specified via environment variables.
 # Certain special ones should be passed via cache (-D) options to CMake.
 # These are only needed for the "prep" target but they are computed globally anyway.
 PREP_OPTS :=

cmake/arch_build.cmake

@@ -12,7 +12,7 @@
 ##################################################################
 
 # define a custom property to track dependencies on CFE module targets.
-# users should not typically maniplate this directly
+# users should not typically manipulate this directly
 define_property(TARGET PROPERTY CFE_MODULE_DEPENDENCIES
     BRIEF_DOCS
         "A set of CFE module dependencies"
@@ -206,7 +206,7 @@ function(add_cfe_tables APP_NAME TBL_SRC_FILES)
                 message("NOTE: Selected ${TBL_SRC} as source for ${APP_NAME}.${TBLWE} on ${TGT}")
 
                 # NOTE: On newer CMake versions this should become an OBJECT library which makes this simpler.
-                # On older versions one may not referece the TARGET_OBJECTS property from the custom command.
+                # On older versions one may not reference the TARGET_OBJECTS property from the custom command.
                 # As a workaround this is built into a static library, and then the desired object is extracted
                 # before passing to elf2cfetbl.  It is roundabout but it works.
                 add_library(${TABLE_LIBNAME} STATIC ${TBL_SRC})
@@ -293,7 +293,7 @@ endfunction(add_cfe_coverage_dependency)
 #
 function(add_cfe_coverage_test MODULE_NAME UNIT_NAME TESTCASE_SRC UT_SRCS)
 
-    # A consistent name convention for all targets generated by this funtion
+    # A consistent name convention for all targets generated by this function
     set(TEST_NAME "coverage-${MODULE_NAME}-${UNIT_NAME}")
     set(OBJECT_TARGET "${TEST_NAME}-object")
     set(RUNNER_TARGET "${TEST_NAME}-testrunner")

cmake/global_functions.cmake

@@ -144,7 +144,7 @@ endfunction(generate_config_includefile)
 #   MISSION_APPS: list of all applications in this build
 #   MISSION_PSPMODULES: list of all psp modules in this build
 #
-# Additionally for each architechture in TGTSYS_LIST:
+# Additionally for each architecture in TGTSYS_LIST:
 #   TGTSYS_<arch>: list of CPU names that utilize the same architecture
 #   TGTSYS_<arch>_APPS: list of apps for the architecture
 #   TGTSYS_<arch>_STATICAPPS: list of static apps for the architecture
@@ -211,7 +211,7 @@ function(read_targetconfig)
 
     set(BUILD_CONFIG ${TOOLCHAIN_NAME} ${${CPUNAME}_PLATFORM})
 
-    # convert to a the string which is safe for a variable name
+    # convert to a string which is safe for a variable name
     string(REGEX REPLACE "[^A-Za-z0-9]" "_" SYSVAR "${BUILD_CONFIG}")
 
     # save the unmodified name for future reference

cmake/mission_build.cmake

@@ -146,7 +146,7 @@ function(generate_build_version_templates)
         VERBATIM
     )
 
-    # Content for build info - these vars can be evaulated right now, no need to defer
+    # Content for build info - these vars can be evaluated right now, no need to defer
     set(GENERATED_FILE_HEADER "/* Automatically generated from CMake build system */")
     string(CONCAT GENERATED_FILE_CONTENT
         "const char CFE_MISSION_NAME[] = \"${MISSION_NAME}\";\n"
@@ -414,7 +414,7 @@ function(process_arch TARGETSYSTEM)
   set(BUILD_CONFIG ${BUILD_CONFIG_${TARGETSYSTEM}})
   list(GET BUILD_CONFIG 0 ARCH_TOOLCHAIN_NAME)
   list(REMOVE_AT BUILD_CONFIG 0)
-  # convert to a the string which is safe for a directory name
+  # convert to a string which is safe for a directory name
   string(REGEX REPLACE "[^A-Za-z0-9]" "_" ARCH_CONFIG_NAME "${BUILD_CONFIG}")
   set(ARCH_BINARY_DIR "${CMAKE_BINARY_DIR}/${ARCH_TOOLCHAIN_NAME}/${ARCH_CONFIG_NAME}")
   file(MAKE_DIRECTORY "${ARCH_BINARY_DIR}" "${ARCH_BINARY_DIR}/inc")
@@ -424,7 +424,7 @@ function(process_arch TARGETSYSTEM)
   # Note - A warning is issued if you pass CMAKE_TOOLCHAIN_FILE to an already-configured build area
   # so an extra check is added to see if this is an initial run or a re-run by checking for a CMakeCache file.
   if (NOT ARCH_TOOLCHAIN_NAME STREQUAL "native" AND NOT EXISTS "${ARCH_BINARY_DIR}/CMakeCache.txt")
-    # Find the toolchain file - allow a file in the mission defs dir to supercede one in the compile dir
+    # Find the toolchain file - allow a file in the mission defs dir to supersede one in the compile dir
     if (EXISTS "${MISSION_DEFS}/toolchain-${ARCH_TOOLCHAIN_NAME}.cmake")
       set(TOOLCHAIN_FILE "${MISSION_DEFS}/toolchain-${ARCH_TOOLCHAIN_NAME}.cmake")
     elseif(EXISTS "${CFE_SOURCE_DIR}/cmake/toolchain-${ARCH_TOOLCHAIN_NAME}.cmake")