From 786d3f4f3865f983b38b7fdc2531fdf380cd1920 Mon Sep 17 00:00:00 2001 From: Avi Date: Wed, 1 Sep 2021 18:04:38 +0200 Subject: [PATCH 1/4] Fixed minor documentation typos (incl. in EDS XML docs). --- CMakeLists.txt | 6 ++--- README.md | 16 ++++++------- SECURITY.md | 2 +- cmake/target/CMakeLists.txt | 2 +- docs/README_static_app_linkage.md | 2 +- docs/cFE Application Developers Guide.md | 16 ++++++------- docs/src/cfe_es.dox | 8 +++---- docs/src/cfe_evs.dox | 6 ++--- docs/src/cfe_sb.dox | 2 +- docs/src/cfe_tbl.dox | 2 +- docs/src/cfe_time.dox | 6 ++--- docs/src/cfs_versions.dox | 4 ++-- docs/src/main.dox | 4 ++-- modules/core_api/CMakeLists.txt | 6 ++--- modules/core_api/eds/base_types.xml | 4 ++-- modules/core_api/eds/ccsds_spacepacket.xml | 8 +++---- modules/core_private/eds/base_types.xml | 4 ++-- modules/es/eds/cfe_es.xml | 28 +++++++++++----------- modules/evs/eds/cfe_evs.xml | 6 ++--- modules/sb/eds/cfe_sb.xml | 26 ++++++++++---------- modules/time/eds/cfe_time.xml | 24 +++++++++---------- 21 files changed, 91 insertions(+), 91 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index c0bb23d19..f313fb20c 100644 --- a/CMakeLists.txt +++ b/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 diff --git a/README.md b/README.md index b38adf224..d35e8a5a8 100644 --- a/README.md +++ b/README.md @@ -188,7 +188,7 @@ The detailed cFE user's guide can be viewed at @@ -400,7 +400,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. @@ -439,7 +439,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 @@ -593,7 +593,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 diff --git a/SECURITY.md b/SECURITY.md index f5cc7d7cf..73314f7ff 100644 --- a/SECURITY.md +++ b/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 diff --git a/cmake/target/CMakeLists.txt b/cmake/target/CMakeLists.txt index c1569fcce..94efbf45d 100644 --- a/cmake/target/CMakeLists.txt +++ b/cmake/target/CMakeLists.txt @@ -245,7 +245,7 @@ if (DEFINED ${TGTNAME}_EMBED_FILELIST) endforeach(LISTENT ${${TGTNAME}_EMBED_FILELIST}) - # Finally, generate a static library that contains all embeded binary files + # Finally, generate a static library that contains all embedded binary files # and add this to the list of libraries that the CFE will be linked with. # add a dependency so that the "inc" files are regenerated and the library # is rebuilt before the static library is built. diff --git a/docs/README_static_app_linkage.md b/docs/README_static_app_linkage.md index a8ed76a09..2a179fb45 100644 --- a/docs/README_static_app_linkage.md +++ b/docs/README_static_app_linkage.md @@ -89,7 +89,7 @@ This allows symbol lookups to succeed even on systems that do not have any dynamic lookup capabilities. Each entry should be a comma-separated pair indicating a symbol name and the -module name that would define it in a dynamically-linked environement. +module name that would define it in a dynamically-linked environment. **NOTE**: To be more portable this operates on the abstract module name as opposed to the file name. This corresponds to the 4th parameter on each line diff --git a/docs/cFE Application Developers Guide.md b/docs/cFE Application Developers Guide.md index 324a2189e..a27942dd0 100644 --- a/docs/cFE Application Developers Guide.md +++ b/docs/cFE Application Developers Guide.md @@ -324,7 +324,7 @@ complete cFE core executive. These modules are all contained under the `modules | `modules/evs/` | Implementation of the Event Services (EVS) core module - manages sending of events on behalf of other apps | | `modules/fs/` | Implementation of the File Services (FS) core module - defines file-related functions | | `modules/msg/` | Implementation of the Message (MSG) core module - defines message header manipulation/access routines | -| `modules/resourceid/` | Implementation of the Resource ID core module - maniplation/access of system resource IDs (AppID, PipeID, etc.) | +| `modules/resourceid/` | Implementation of the Resource ID core module - manipulation/access of system resource IDs (AppID, PipeID, etc.) | | `modules/sb/` | Implementation of the Software Bus (SB) core module - sends messages between applications | | `modules/tbl/` | Implementation of the Table Services (TBL) core module - manages runtime tables | | `modules/time/` | Implementation of the Time Services (TIME) core module - manages timing and synchronization | @@ -488,7 +488,7 @@ deciding on whether to create multiple Applications versus a single Application with multiple Tasks, the Application Developer should keep in mind these facts: -- When the Application exits it is the responsiabilty of the +- When the Application exits it is the responsibility of the Main Task to safely stop all of its Child Tasks. - If the Main Task of an Application is stopped, either through @@ -897,7 +897,7 @@ to the OSAL Library API). ## 5.8 Interrupt Handling OSAL interrupt handling functions have been deprecated due to -platform dependencies, incomplete testing, and incomplete implementaion +platform dependencies, incomplete testing, and incomplete implementation No longer supporting abstracted interrupt handling API from OSAL. Could consider at the PSP layer as future work but current dependencies should @@ -979,7 +979,7 @@ equal to the requested block size. The specific size of the management structure depends on the platform architecture word size and alignment requirements, and padding may be added as necessary to meet the system requirements. For illustrative -purposes, the examples below use sizes that are respresentative of a +purposes, the examples below use sizes that are representative of a 32-bit CPU with 32-bit buffer alignment with no extra alignment padding added. The pool overhead will increase on a 64-bit CPU with 64-bit alignment, or if pool alignment configured greater than 32 bits. For @@ -1035,8 +1035,8 @@ Figure 5.2 Example mempool allocations ### 5.10.2 Memory Read/Write Functions CFE provides a set of functions that read and write values of fixed sizes at -specified physical addresses. These functions are intended for accessing h -ardware registers or memory devices with nonstandard properties. The EEPROM +specified physical addresses. These functions are intended for accessing +hardware registers or memory devices with nonstandard properties. The EEPROM functions perform whatever operations are required for enabling the modification of EEPROM and then verify that the modification was successful. @@ -1406,9 +1406,9 @@ structure can be changed without affecting cFS Applications. See the implementation documentation for specific formats, fields, and bit values. The message ID (MsgId) is an abstract -concept that is implementation depended, used for routing messages +concept that is implementation dependent, used for routing messages on the Software Bus. Depending on the implementation, different -ranges and values are supported, and the values effect the message +ranges and values are supported, and the values affect the message header differently. If you are using the default, MsgID maps directly to the CCSDS Stream ID. diff --git a/docs/src/cfe_es.dox b/docs/src/cfe_es.dox index b8b95a8b7..70a40b432 100644 --- a/docs/src/cfe_es.dox +++ b/docs/src/cfe_es.dox @@ -14,7 +14,7 @@ through the Platform Support Package (PSP). The functionality provided by the ES task include Software Reset, - Application and Child Task Mangement, Basic File System, Performance Data + Application and Child Task Management, Basic File System, Performance Data Collection, Critical Data Store, Memory Pool, System Log, Shell Command. For additional detail on Executive Services, see the following sections: @@ -385,7 +385,7 @@ The #CFE_ES_RELOAD_APP_CC command is used to reload an application using a new file name. - This command performes + This command performs the same actions as #CFE_ES_RESTART_APP_CC only using the new file. Next: \ref cfeesugapplist
@@ -420,7 +420,7 @@
  • Load Address - The starting address of memory where the Application was loaded
  • Load Size - The size, in bytes, of the Application when loaded into memory
  • Start Address - The physical address that maps to the Entry Point
    -
  • Exception Action - A flag that identifies whether the the Processor should undergo +
  • Exception Action - A flag that identifies whether the Processor should undergo a Restart or whether just the Application should restart upon an exception condition within the Application
  • Priority - The assigned priority for the Application
    @@ -754,7 +754,7 @@
    • Memory Pool Handle - the handle, as provided by the operator in the \link #CFE_ES_SEND_MEM_POOL_STATS_CC Telemeter Memory Pool Statistics Command. \endlink - This repeating of the handle in telemetry insures the operator knows which Memory + This repeating of the handle in telemetry ensures the operator knows which Memory Pool Statistics are being viewed
    • Pool Size - The total size of the memory pool (in bytes)
    • Number Blocks Requested - The total number of memory blocks requested for allocation
      diff --git a/docs/src/cfe_evs.dox b/docs/src/cfe_evs.dox index 7587a9ef6..b1c9648da 100644 --- a/docs/src/cfe_evs.dox +++ b/docs/src/cfe_evs.dox @@ -8,7 +8,7 @@ application or core service. EVS provides various ways to filter event messages in order to manage event message generation. - Note for messages outside the context of a registered appliction (for example early + Note for messages outside the context of a registered application (for example early in app initialization or if registration fails) #CFE_ES_WriteToSysLog can be used for reporting. @@ -140,7 +140,7 @@ When commands are sent to \link #CFE_EVS_ENABLE_EVENT_TYPE_CC enable \endlink or \link #CFE_EVS_DISABLE_EVENT_TYPE_CC disable \endlink a particular type of event message, ALL event messages of the specified type are affected. Typically, event - meesages of type DEBUG are disabled on-orbit. Note that EVS provides the capability + messages of type DEBUG are disabled on-orbit. Note that EVS provides the capability to affect multiple types within one command using a bit mask. Note also that the configuration parameter #CFE_PLATFORM_EVS_DEFAULT_TYPE_FLAG in the cfe_platform_cfg.h file specifies which event message types are enabled/disabled by default. @@ -188,7 +188,7 @@ for filtering. Once an event is \link #CFE_EVS_ADD_EVENT_FILTER_CC registered for filtering \endlink, the filter can be modified (see above) or \link #CFE_EVS_DELETE_EVENT_FILTER_CC removed \endlink. - An on-orbit mission, for example, might be experiencing a problem resulting in a event + An on-orbit mission, for example, might be experiencing a problem resulting in an event message being repeatedly issued, flooding the downlink. If the event message was not registered with EVS for filtering then the ground can add (i.e. register) the offending application's event for filtering (much like an application registers the event during diff --git a/docs/src/cfe_sb.dox b/docs/src/cfe_sb.dox index 0f07d62fd..09effca0b 100644 --- a/docs/src/cfe_sb.dox +++ b/docs/src/cfe_sb.dox @@ -294,7 +294,7 @@ For a telemetry message, the behavior is controlled via API input parameters when sending. When enabled, the software bus will populate the packet sequence - counter using an internal counter that gets intialized upon the first subscription to the + counter using an internal counter that gets initialized upon the first subscription to the message (first message will have a packet sequence counter value of 1). From that point on each send request will increment the counter by one, regardless of the number of destinations or if there is an active subscription. diff --git a/docs/src/cfe_tbl.dox b/docs/src/cfe_tbl.dox index cdbe6ca38..646a71374 100644 --- a/docs/src/cfe_tbl.dox +++ b/docs/src/cfe_tbl.dox @@ -229,7 +229,7 @@ On occasion, cFE Applications require a segment of memory in which the Application writes data. The typical cFE Table is not normally modified directly by an Application but only via Load and Activate commands from either the Ground or Stored Command Processor. However, for those situations where an Application wishes to - modify the contents of a data structure and the Application is limited in its telemtry bandwidth so that the + modify the contents of a data structure and the Application is limited in its telemetry bandwidth so that the modified data cannot be telemetered, the Application can create a Dump-Only table. Dump-Only tables are not allowed to be modified via the Load/Validate/Activate process most other tables are. diff --git a/docs/src/cfe_time.dox b/docs/src/cfe_time.dox index faa177754..b191b984d 100644 --- a/docs/src/cfe_time.dox +++ b/docs/src/cfe_time.dox @@ -127,7 +127,7 @@ structure is used by TIME to store current time, time at the tone, time since the tone, the MET, the STCF and command arguments for time adjustments. Note that typically the 32 bits of seconds and the upper 16 bits of subseconds are used for time stamping - Software bus messages, but this is dependent on the underlying defintion. + Software bus messages, but this is dependent on the underlying definition. The system time structure is defined as follows: @@ -674,7 +674,7 @@ /** \page cfetimeugnormal Normal Operation - The following sections describe the operator's resposibilities for maintaining + The following sections describe the operator's responsibilities for maintaining time under nominal conditions:
        @@ -757,7 +757,7 @@ \page cfetimeugadjust Adjusting Time The TIME Server includes commands to set the STCF, Leap Seconds, - and Validity state. The STCF should be set implicity using the + and Validity state. The STCF should be set implicitly using the #CFE_TIME_SET_TIME_CC or explicitly using #CFE_TIME_SET_STCF_CC. TIME provides the ability to command a one time adjustment (#CFE_TIME_ADD_ADJUST_CC and #CFE_TIME_SUB_ADJUST_CC) diff --git a/docs/src/cfs_versions.dox b/docs/src/cfs_versions.dox index 06853530d..8e3c871fb 100644 --- a/docs/src/cfs_versions.dox +++ b/docs/src/cfs_versions.dox @@ -43,7 +43,7 @@ The BUILD_NUMBER reflects the number of commits since the BUILD_BASELINE, a baseline git tag, for each particular component. The BUILD_NUMBER integer monotonically increases for a given baseline. The BUILD_BASELINE identifies the current development cycle and is a git tag with format vX.Y.Z. The Codename used in the version - string also refers to the current development cycle. When a new baseline tag and codename are created, the the + string also refers to the current development cycle. When a new baseline tag and codename are created, the BUILD_NUMBER resets to zero and begins increasing from a new baseline.

        Templates for the short and long version string

        @@ -53,7 +53,7 @@ name; for example, osal uses OS_, psp uses CFE_PSP_IMPL, and so on. Suggested pattern for development: - - XXX_SRC_VERSION: REFRENCE_GIT_TAG"+dev"BUILD_NUMBER + - XXX_SRC_VERSION: REFERENCE_GIT_TAG"+dev"BUILD_NUMBER - Example: "v6.8.0-rc1+dev123" - XXX_VERSION_STRING: "XXX DEVELOPMENT BUILD "XXX_SRC_VERSION" (Codename: YYY), Last Official Release: ZZZ" - Example: "cFE DEVELOPMENT BUILD v6.8.0-rc1+dev123 (Codename: Bootes), Last Official Release: cfe v6.7.0" diff --git a/docs/src/main.dox b/docs/src/main.dox index 9ecc545cb..e6a7150f9 100644 --- a/docs/src/main.dox +++ b/docs/src/main.dox @@ -164,8 +164,8 @@ \page cfedependencies Dependencies The Core Flight Executive (cFE) is required to be built with the Operating System Abstraction Layer (OSAL) and Platform Support Package (PSP) - componenets of the Core Flight System (cFS). It is always recommended to build with the latest versions of each of the components as - backward compatability may not be supported.
        + components of the Core Flight System (cFS). It is always recommended to build with the latest versions of each of the components as + backward compatibility may not be supported.
        Several internal data structures within the cFE use the "char" data type. This data type is typically 1 byte in storage size with a value range -128 to 127 or 0 to 255. The size of the "char" data type and whether or not the type is signed or unsigned can change across diff --git a/modules/core_api/CMakeLists.txt b/modules/core_api/CMakeLists.txt index 377c6506e..ebdacd669 100644 --- a/modules/core_api/CMakeLists.txt +++ b/modules/core_api/CMakeLists.txt @@ -4,15 +4,15 @@ # ################################################################## -# NOTE: This module is shared headers and configuration only, it has has no -# source files of its own. It just defines the intefaces betwen the CFE core +# NOTE: This module is shared headers and configuration only, it has no +# source files of its own. It just defines the interfaces between the CFE core # modules and other private headers that define CFE internal shared data objects. add_library(core_api INTERFACE) # The fsw/inc here defines global/shared structures and interfaces target_include_directories(core_api INTERFACE fsw/inc) -# Propagate any INTERFACE-level include dirs and compile defintions from +# Propagate any INTERFACE-level include dirs and compile definitions from # the modules into this abstract interface target foreach(MOD ${MISSION_CORE_MODULES}) target_include_directories(core_api INTERFACE diff --git a/modules/core_api/eds/base_types.xml b/modules/core_api/eds/base_types.xml index 9f510458c..aac48fcf7 100644 --- a/modules/core_api/eds/base_types.xml +++ b/modules/core_api/eds/base_types.xml @@ -23,11 +23,11 @@ as prescribed in CCSDS book 876.0. Purpose: - This describes stardard data types used throughout the Core Flight System + This describes standard data types used throughout the Core Flight System --> - + diff --git a/modules/core_api/eds/ccsds_spacepacket.xml b/modules/core_api/eds/ccsds_spacepacket.xml index 8f89d41d7..398ebded1 100644 --- a/modules/core_api/eds/ccsds_spacepacket.xml +++ b/modules/core_api/eds/ccsds_spacepacket.xml @@ -24,11 +24,11 @@ Purpose: This describes objects as defined by CCSDS book 133 Space Packet Protocol - and utilized by the Core Fligh System (cFS) + and utilized by the Core Flight System (cFS) --> - + @@ -77,7 +77,7 @@ - Command codes in CFE range are 7 bits (0-127). The most signficant bit (codes 128-255) are reserved. + Command codes in CFE range are 7 bits (0-127). The most significant bit (codes 128-255) are reserved. @@ -160,7 +160,7 @@ diff --git a/modules/core_private/eds/base_types.xml b/modules/core_private/eds/base_types.xml index 9f510458c..aac48fcf7 100644 --- a/modules/core_private/eds/base_types.xml +++ b/modules/core_private/eds/base_types.xml @@ -23,11 +23,11 @@ as prescribed in CCSDS book 876.0. Purpose: - This describes stardard data types used throughout the Core Flight System + This describes standard data types used throughout the Core Flight System --> - + diff --git a/modules/es/eds/cfe_es.xml b/modules/es/eds/cfe_es.xml index 5e2f2077b..2e4bdf978 100644 --- a/modules/es/eds/cfe_es.xml +++ b/modules/es/eds/cfe_es.xml @@ -617,7 +617,7 @@ \cfetlmmnemonic \ES_PERFMODE - + \cfetlmmnemonic \ES_PERFTRIGCNT @@ -996,7 +996,7 @@ increment - The #CFE_ES_STOP_DBG_EID debug event message will be generated. NOTE: This event message only identifies that the - stop has been started, not that is has completed. + stop has been started, not that it has completed. - Once the stop has successfully completed, the list of Applications and Tasks created in response to the \b \c \ES_WRITEAPPINFO2FILE, \b \c \ES_WRITETASKINFO2FILE should no longer contain the @@ -1011,7 +1011,7 @@ Evidence of failure may be found in the following telemetry: - \b \c \ES_CMDEC - command error counter will increment - - A command specific error event message is issued forall error + - A command specific error event message is issued for all error cases - Additional information on the reason for command failure may be found in the System Log @@ -1054,7 +1054,7 @@ increment - The #CFE_ES_RESTART_APP_DBG_EID debug event message will be generated. NOTE: This event message only identifies that the - act of stopping the application has begun, not that is has completed. + act of stopping the application has begun, not that it has completed. \par Error Conditions @@ -1111,7 +1111,7 @@ increment - The #CFE_ES_RELOAD_APP_DBG_EID debug event message will be generated. NOTE: This event message only identifies that the - act of stopping the application has begun, not that is has completed. + act of stopping the application has begun, not that it has completed. \par Error Conditions @@ -1164,7 +1164,7 @@ increment - The #CFE_ES_ONE_APP_EID debug event message will be generated. NOTE: This event message only identifies that the - act of stopping the application has begun, not that is has completed. + act of stopping the application has begun, not that it has completed. - Receipt of the #CFE_ES_APP_TLM_t telemetry packet \par Error Conditions @@ -1214,7 +1214,7 @@ generated. - The file specified in the command (or the default specified by the #CFE_ES_DEFAULT_APP_LOG_FILE configuration parameter) will be - updated with the lastest information. + updated with the latest information. \par Error Conditions @@ -1313,7 +1313,7 @@ generated. - The file specified in the command (or the default specified by the #CFE_ES_DEFAULT_SYSLOG_FILE configuration parameter) will be - updated with the lastest information. + updated with the latest information. \par Error Conditions @@ -1346,7 +1346,7 @@ - \cfeescmd Clears the contents of the Exeception and Reset Log + \cfeescmd Clears the contents of the Exception and Reset Log \par Description @@ -1391,7 +1391,7 @@ - \cfeescmd Writes Exeception and Reset Log to a File + \cfeescmd Writes Exception and Reset Log to a File \par Description @@ -1412,7 +1412,7 @@ generated. - The file specified in the command (or the default specified by the #CFE_ES_DEFAULT_ER_LOG_FILE configuration parameter) will be - updated with the lastest information. + updated with the latest information. \par Error Conditions @@ -1523,7 +1523,7 @@ generated. - The file specified in the command (or the default specified by the #CFE_ES_DEFAULT_PERF_DUMP_FILENAME configuration parameter) will be - updated with the lastest information. + updated with the latest information. \par Error Conditions @@ -1930,7 +1930,7 @@ generated. - The file specified in the command (or the default specified by the #CFE_ES_DEFAULT_CDS_REG_DUMP_FILE configuration parameter) will be - updated with the lastest information. + updated with the latest information. \par Error Conditions @@ -1982,7 +1982,7 @@ generated. - The file specified in the command (or the default specified by the #CFE_ES_DEFAULT_TASK_LOG_FILE configuration parameter) will be - updated with the lastest information. + updated with the latest information. \par Error Conditions diff --git a/modules/evs/eds/cfe_evs.xml b/modules/evs/eds/cfe_evs.xml index 1ebc1f262..dcadb6701 100644 --- a/modules/evs/eds/cfe_evs.xml +++ b/modules/evs/eds/cfe_evs.xml @@ -90,7 +90,7 @@ For command details, see #CFE_EVS_FILE_WRITE_APP_DATA_CC - + @@ -597,7 +597,7 @@ - An Error specific event message \par Criticality - Enabling an application¿s event type is not particularly hazardous, as + Enabling an application's event type is not particularly hazardous, as the result may be turning on necessary event messages and communication to the ground system. However, inappropriately enabling an application's event type could result in flooding of the ground system. @@ -701,7 +701,7 @@ - An Error specific event message \par Criticality - Enabling an application¿s events is not particularly hazardous, + Enabling an application's events is not particularly hazardous, as the result may be turning on necessary event messages and communication to the ground system. However, inappropriately enabling an application's events could result in flooding of the ground system. diff --git a/modules/sb/eds/cfe_sb.xml b/modules/sb/eds/cfe_sb.xml index 57f1a939d..f93c349a3 100644 --- a/modules/sb/eds/cfe_sb.xml +++ b/modules/sb/eds/cfe_sb.xml @@ -51,7 +51,7 @@ - + @@ -526,7 +526,7 @@ This command will create a file containing the software bus routing information. The routing information contains information about every subscription that has been received through the SB subscription APIs. - An abosulte path and filename may be specified in the command. + An absolute path and filename may be specified in the command. If this command field contains an empty string (NULL terminator as the first character) the default file path and name is used. The default file path and name is defined in the platform @@ -575,7 +575,7 @@ \par Description This command will enable a particular destination. The destination is specified in terms of MsgID and PipeID. The MsgId and PipeID are - parmaters in the command. All destinations are enabled by default. + parameters in the command. All destinations are enabled by default. This command is needed only after a #CFE_SB_DISABLE_ROUTE_CC command is used. \cfecmdmnemonic \SB_ENAROUTE @@ -594,7 +594,7 @@ - Destination will begin receiving messages. \par Error Conditions - An Error may occur if the MsgId or PipeId parmaters do not pass + An Error may occur if the MsgId or PipeId parameters do not pass validation or the destination does not exist. Evidence of failure may be found in the following telemetry: - \b \c \SB_CMDEC - command error counter will increment @@ -621,7 +621,7 @@ \par Description This command will disable a particular destination. The destination is specified in terms of MsgID and PipeID. The MsgId and PipeID are - parmaters in the command. All destinations are enabled by default. + parameters in the command. All destinations are enabled by default. \cfecmdmnemonic \SB_DISROUTE \par Command Structure @@ -638,7 +638,7 @@ - Destination will stop receiving messages. \par Error Conditions - An Error may occur if the MsgId or PipeId parmaters do not pass + An Error may occur if the MsgId or PipeId parameters do not pass validation or the destination does not exist. Evidence of failure may be found in the following telemetry: - \b \c \SB_CMDEC - command error counter will increment @@ -648,7 +648,7 @@ \par Criticality This command is not intended to be used in nominal conditions. It is possible to get into a state where a destination cannot be re-enabled - without reseting the processor. For instance, sending this command + without resetting the processor. For instance, sending this command with #CFE_SB_CMD_MID and the SB_Cmd_Pipe would inhibit any ground commanding to the software bus until the processor was reset. There are similar problems that may occur when using this command. @@ -671,7 +671,7 @@ This command will create a file containing the software bus pipe information. The pipe information contains information about every pipe that has been created through the #CFE_SB_CreatePipe API. An - abosulte path and filename may be specified in the command. + absolute path and filename may be specified in the command. If this command field contains an empty string (NULL terminator as the first character) the default file path and name is used. The default file path and name is defined in the platform @@ -720,9 +720,9 @@ \par This command will create a file containing the software bus message map information. The message map is a lookup table (an array of uint16s)that allows fast access to the correct routing table element - during a softeware bus send operation. This is diasgnostic + during a software bus send operation. This is diagnostic information that may be needed due to the dynamic nature of the - cFE software bus. An abosulte path and filename may be specified + cFE software bus. An absolute path and filename may be specified in the command. If this command field contains an empty string (NULL terminator as the first character) the default file path and name is used. The default file path and name is defined in the @@ -775,7 +775,7 @@ and send a software bus packet for each subscription received. The software bus packet that is sent contains the information received in the subscription API. This subscription report is - neeeded by SBN if offboard routing is required. + needed by SBN if offboard routing is required. \cfecmdmnemonic \SB_ENASUBRPTG \par Command Structure @@ -811,7 +811,7 @@ and send a software bus packet for each subscription received. The software bus packet that is sent contains the information received in the subscription API. This subscription report is - neeeded by SBN if offboard routing is required. + needed by SBN if offboard routing is required. \cfecmdmnemonic \SB_DISSUBRPTG \par Command Structure @@ -896,7 +896,7 @@ This represents the access interface used for passing message datagrams to and from the message transfer service (MTS). It operates using publish/subscribe - semantics, where messages are sent and received using an abstract idenifier referred + semantics, where messages are sent and received using an abstract identifier referred to as a software bus message ID. This essentially acts as a filter on the underlying MTS interface, where outgoing traffic is "tagged" with the appropriate MsgId and only the specified MsgId passes through on the receive side. diff --git a/modules/time/eds/cfe_time.xml b/modules/time/eds/cfe_time.xml index c146b6bd7..481bb805e 100644 --- a/modules/time/eds/cfe_time.xml +++ b/modules/time/eds/cfe_time.xml @@ -53,7 +53,7 @@ \par Description The #CFE_TIME_ClockState_Enum_t enumerations identify the three recognized states of the current time. If the clock has never been successfully synchronized with the primary onboard clock source, the - time is conisdered to be #CFE_TIME_ClockState_INVALID. If the time is currently synchronized (i.e. - the + time is considered to be #CFE_TIME_ClockState_INVALID. If the time is currently synchronized (i.e. - the primary synchronization mechanism has not been dropped for any significant amount of time), then the current time is considered to be #CFE_TIME_ClockState_VALID. If the time had, at some point in the past, been synchronized, but the synchronization with the primary onboard clock has since been lost, then @@ -732,7 +732,7 @@ \par Error Conditions - An invalid number of microseconds was specified (must be less than 1 million) - - Platorm receiving the command is not a Time Client + - Platform receiving the command is not a Time Client Evidence of Failure may be found in the following telemetry: - \b \c \TIME_CMDEC - command error counter will increment @@ -779,7 +779,7 @@ \par Error Conditions - An invalid number of microseconds was specified (must be less than 1 million) - - Platorm receiving the command is not a Time Client + - Platform receiving the command is not a Time Client Evidence of Failure may be found in the following telemetry: - \b \c \TIME_CMDEC - command error counter will increment @@ -818,7 +818,7 @@ If Time Service is configured to compute current time as UTC - STCF = ((new time) - (current MET)) + (Leap Seconds) - - (current time) = ((curent MET) + STCF) - (Leap Seconds) + - (current time) = ((current MET) + STCF) - (Leap Seconds) \cfecmdmnemonic \TIME_SETCLOCK \par Command Structure @@ -834,7 +834,7 @@ \par Error Conditions - An invalid number of microseconds was specified (must be less than 1 million) - - Platorm receiving the command is not a Time Server + - Platform receiving the command is not a Time Server Evidence of Failure may be found in the following telemetry: - \b \c \TIME_CMDEC - command error counter will increment @@ -885,7 +885,7 @@ \par Error Conditions - An invalid number of microseconds was specified (must be less than 1 million) - - Platorm receiving the command is not a Time Server + - Platform receiving the command is not a Time Server Evidence of Failure may be found in the following telemetry: - \b \c \TIME_CMDEC - command error counter will increment @@ -930,7 +930,7 @@ \par Error Conditions - An invalid number of microseconds was specified (must be less than 1 million) - - Platorm receiving the command is not a Time Server + - Platform receiving the command is not a Time Server Evidence of Failure may be found in the following telemetry: - \b \c \TIME_CMDEC - command error counter will increment @@ -973,7 +973,7 @@ - The #CFE_TIME_LEAPS_EID informational event message will be generated \par Error Conditions - - Platorm receiving the command is not a Time Server + - Platform receiving the command is not a Time Server Evidence of Failure may be found in the following telemetry: - \b \c \TIME_CMDEC - command error counter will increment @@ -1016,7 +1016,7 @@ \par Error Conditions - An invalid number of microseconds was specified (must be less than 1 million) - - Platorm receiving the command is not a Time Server + - Platform receiving the command is not a Time Server Evidence of Failure may be found in the following telemetry: - \b \c \TIME_CMDEC - command error counter will increment @@ -1058,7 +1058,7 @@ \par Error Conditions - An invalid number of microseconds was specified (must be less than 1 million) - - Platorm receiving the command is not a Time Server + - Platform receiving the command is not a Time Server Evidence of Failure may be found in the following telemetry: - \b \c \TIME_CMDEC - command error counter will increment @@ -1114,7 +1114,7 @@ - The #CFE_TIME_1HZ_EID informational event message will be generated \par Error Conditions - - Platorm receiving the command is not a Time Server + - Platform receiving the command is not a Time Server Evidence of Failure may be found in the following telemetry: - \b \c \TIME_CMDEC - command error counter will increment @@ -1170,7 +1170,7 @@ - The #CFE_TIME_1HZ_EID informational event message will be generated \par Error Conditions - - Platorm receiving the command is not a Time Server + - Platform receiving the command is not a Time Server Evidence of Failure may be found in the following telemetry: - \b \c \TIME_CMDEC - command error counter will increment From 91d4bb8e2ad426d8344b966bc32717c30ce7f1ff Mon Sep 17 00:00:00 2001 From: Avi Date: Wed, 1 Sep 2021 18:27:24 +0200 Subject: [PATCH 2/4] Fixed minor comment typos. --- cmake/Makefile.sample | 2 +- cmake/arch_build.cmake | 6 +- cmake/global_functions.cmake | 4 +- cmake/mission_build.cmake | 6 +- cmake/mission_defaults.cmake | 4 +- cmake/sample_defs/cpu1_cfe_es_startup.scr | 2 +- cmake/sample_defs/cpu1_platform_cfg.h | 78 +++++++++---------- cmake/sample_defs/native_osconfig.cmake | 2 +- cmake/sample_defs/sample_mission_cfg.h | 6 +- cmake/sample_defs/targets.cmake | 2 +- cmake/target/inc/target_config.h | 2 +- cmake/target/src/target_config.c | 2 +- modules/cfe_assert/inc/cfe_assert.h | 4 +- modules/cfe_testcase/src/msg_api_test.c | 2 +- modules/cfe_testcase/src/sb_pipe_mang_test.c | 2 +- .../src/tbl_content_access_test.c | 2 +- modules/cfe_testcase/src/time_misc_test.c | 2 +- modules/core_api/fsw/inc/cfe_endian.h | 2 +- modules/core_api/fsw/inc/cfe_error.h | 16 ++-- modules/core_api/fsw/inc/cfe_es.h | 14 ++-- .../core_api/fsw/inc/cfe_es_api_typedefs.h | 4 +- .../core_api/fsw/inc/cfe_es_extern_typedefs.h | 8 +- modules/core_api/fsw/inc/cfe_evs.h | 6 +- .../core_api/fsw/inc/cfe_evs_api_typedefs.h | 2 +- .../core_api/fsw/inc/cfe_fs_api_typedefs.h | 4 +- modules/core_api/fsw/inc/cfe_msg.h | 4 +- .../core_api/fsw/inc/cfe_msg_api_typedefs.h | 4 +- modules/core_api/fsw/inc/cfe_sb.h | 6 +- .../core_api/fsw/inc/cfe_sb_extern_typedefs.h | 2 +- modules/core_api/fsw/inc/cfe_tbl.h | 10 +-- .../fsw/inc/cfe_tbl_extern_typedefs.h | 2 +- modules/core_api/fsw/inc/cfe_time.h | 6 +- .../fsw/inc/cfe_time_extern_typedefs.h | 2 +- modules/core_api/fsw/inc/cfe_version.h | 2 +- .../core_api/ut-stubs/src/cfe_es_handlers.c | 2 +- .../fsw/inc/cfe_core_resourceid_basevalues.h | 4 +- modules/core_private/fsw/inc/cfe_sbr.h | 2 +- .../core_private/ut-stubs/inc/ut_support.h | 8 +- modules/es/fsw/inc/cfe_es_events.h | 6 +- modules/es/fsw/inc/cfe_es_msg.h | 26 +++---- modules/es/fsw/src/cfe_es_api.c | 4 +- modules/es/fsw/src/cfe_es_apps.c | 4 +- modules/es/fsw/src/cfe_es_apps.h | 4 +- modules/es/fsw/src/cfe_es_cds_mempool.c | 2 +- modules/es/fsw/src/cfe_es_erlog.c | 2 +- modules/es/fsw/src/cfe_es_generic_pool.h | 2 +- modules/es/fsw/src/cfe_es_log.h | 2 +- modules/es/fsw/src/cfe_es_mempool.c | 2 +- modules/es/fsw/src/cfe_es_mempool.h | 4 +- modules/es/fsw/src/cfe_es_perf.h | 2 +- modules/es/fsw/src/cfe_es_resource.h | 14 ++-- modules/es/fsw/src/cfe_es_syslog.c | 2 +- modules/es/fsw/src/cfe_es_task.c | 2 +- modules/es/fsw/src/cfe_es_task.h | 2 +- modules/es/ut-coverage/es_UT.c | 14 ++-- modules/es/ut-coverage/es_UT.h | 2 +- modules/evs/fsw/inc/cfe_evs_events.h | 4 +- modules/evs/fsw/inc/cfe_evs_msg.h | 4 +- modules/evs/fsw/src/cfe_evs_task.c | 16 ++-- modules/evs/fsw/src/cfe_evs_task.h | 2 +- modules/evs/ut-coverage/evs_UT.c | 4 +- modules/fs/ut-coverage/fs_UT.c | 4 +- modules/msg/fsw/inc/ccsds_hdr.h | 2 +- .../option_inc/cfe_resourceid_simple.h | 4 +- .../option_inc/cfe_resourceid_strict.h | 2 +- modules/sb/fsw/inc/cfe_sb_events.h | 8 +- modules/sb/fsw/inc/cfe_sb_msg.h | 30 +++---- modules/sb/fsw/src/cfe_sb_api.c | 12 +-- modules/sb/fsw/src/cfe_sb_buf.c | 2 +- modules/sb/fsw/src/cfe_sb_init.c | 2 +- modules/sb/fsw/src/cfe_sb_priv.c | 2 +- modules/sb/fsw/src/cfe_sb_priv.h | 20 ++--- modules/sb/fsw/src/cfe_sb_task.c | 4 +- modules/sb/ut-coverage/sb_UT.c | 14 ++-- modules/sb/ut-coverage/sb_UT.h | 6 +- modules/sbr/fsw/src/cfe_sbr_map_hash.c | 2 +- modules/sbr/fsw/src/cfe_sbr_route_unsorted.c | 2 +- .../ut-coverage/test_cfe_sbr_route_unsorted.c | 4 +- modules/tbl/fsw/inc/cfe_tbl_events.h | 14 ++-- modules/tbl/fsw/inc/cfe_tbl_msg.h | 4 +- modules/tbl/fsw/src/cfe_tbl_task.h | 2 +- modules/tbl/ut-coverage/tbl_UT.c | 6 +- modules/time/fsw/inc/cfe_time_events.h | 4 +- modules/time/fsw/inc/cfe_time_msg.h | 22 +++--- modules/time/fsw/src/cfe_time_tone.c | 4 +- modules/time/fsw/src/cfe_time_utils.c | 2 +- modules/time/fsw/src/cfe_time_utils.h | 4 +- modules/time/ut-coverage/time_UT.c | 4 +- 88 files changed, 275 insertions(+), 275 deletions(-) diff --git a/cmake/Makefile.sample b/cmake/Makefile.sample index f1d08f4d0..683c9dc75 100644 --- a/cmake/Makefile.sample +++ b/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 := diff --git a/cmake/arch_build.cmake b/cmake/arch_build.cmake index e51547e1c..5b76cb18a 100644 --- a/cmake/arch_build.cmake +++ b/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") diff --git a/cmake/global_functions.cmake b/cmake/global_functions.cmake index 38477192c..d007d614a 100644 --- a/cmake/global_functions.cmake +++ b/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_: list of CPU names that utilize the same architecture # TGTSYS__APPS: list of apps for the architecture # TGTSYS__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 diff --git a/cmake/mission_build.cmake b/cmake/mission_build.cmake index 11095431c..98bf76b2a 100644 --- a/cmake/mission_build.cmake +++ b/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") diff --git a/cmake/mission_defaults.cmake b/cmake/mission_defaults.cmake index a4a2374b8..7b288e5e8 100644 --- a/cmake/mission_defaults.cmake +++ b/cmake/mission_defaults.cmake @@ -12,7 +12,7 @@ # a set of include directories and compile options for all modules, # including the ubiquitous "cfe.h" header file and all it depends on). # NOTE: these interfaces are really what defines "CFE core" - changing -# this list is not recommend, as these interface names are important. +# this list is not recommended, as these interface names are important. set(MISSION_CORE_INTERFACES core_api # this is the "public" core API that apps use, includes cfe.h and all core headers core_private # this is the "private" interface that core apps use, but not used by apps @@ -21,7 +21,7 @@ set(MISSION_CORE_INTERFACES # The "MISSION_CORE_MODULES" will be built and statically linked as part # of the CFE core executable on every target. These can be used to amend # or override parts of the CFE core on a mission-specific basis. -# NOTE: Everthing in this list becomes part of the "core_api" interface above. +# NOTE: Everything in this list becomes part of the "core_api" interface above. # Missions may add/remove/replace components in this list as needed. set(MISSION_CORE_MODULES "es" diff --git a/cmake/sample_defs/cpu1_cfe_es_startup.scr b/cmake/sample_defs/cpu1_cfe_es_startup.scr index 379f4bce4..4ddc6cbfb 100644 --- a/cmake/sample_defs/cpu1_cfe_es_startup.scr +++ b/cmake/sample_defs/cpu1_cfe_es_startup.scr @@ -9,7 +9,7 @@ CFE_APP, sch_lab, SCH_Lab_AppMain, SCH_LAB_APP, 80, 16384, 0x0, 0; ! 1. Object Type -- CFE_APP for an Application, or CFE_LIB for a library. ! 2. Path/Filename -- This is a cFE Virtual filename, not a vxWorks device/pathname ! 3. Entry Point -- This is the "main" function for Apps. -! 4. CFE Name -- The cFE name for the the APP or Library +! 4. CFE Name -- The cFE name for the APP or Library ! 5. Priority -- This is the Priority of the App, not used for Library ! 6. Stack Size -- This is the Stack size for the App, not used for the Library ! 7. Load Address -- This is the Optional Load Address for the App or Library. Currently not implemented diff --git a/cmake/sample_defs/cpu1_platform_cfg.h b/cmake/sample_defs/cpu1_platform_cfg.h index ce6769644..5917e4cd0 100644 --- a/cmake/sample_defs/cpu1_platform_cfg.h +++ b/cmake/sample_defs/cpu1_platform_cfg.h @@ -69,7 +69,7 @@ ** ** \par Description: ** Dictates the maximum number of unique MsgIds the SB routing table will hold. -** This constant has a direct affect on the size of SB's tables and arrays. +** This constant has a direct effect on the size of SB's tables and arrays. ** Keeping this count as low as possible will save memory. ** To see the run-time, high-water mark and the current utilization figures ** regarding this parameter, send an SB command to 'Send Statistics Pkt'. @@ -89,7 +89,7 @@ ** ** \par Description: ** Dictates the maximum number of unique Pipes the SB routing table will hold. -** This constant has a direct affect on the size of SB's tables and arrays. +** This constant has a direct effect on the size of SB's tables and arrays. ** Keeping this count as low as possible will save memory. ** To see the run-time, high-water mark and the current utilization figures ** regarding this parameter, send an SB command to 'Send Statistics Pkt'. @@ -161,12 +161,12 @@ ** The value of this constant dictates the range of valid message ID's, from 0 ** to CFE_PLATFORM_SB_HIGHEST_VALID_MSGID (inclusive). ** -** Altough this can be defined differently across platforms, each platform can +** Although this can be defined differently across platforms, each platform can ** only publish/subscribe to message ids within their allowable range. Typically ** this value is set the same across all mission platforms to avoid this complexity. ** ** \par Limits -** CFE_SB_INVALID_MSG is set to the maxumum representable number of type CFE_SB_MsgId_t. +** CFE_SB_INVALID_MSG is set to the maximum representable number of type CFE_SB_MsgId_t. ** CFE_PLATFORM_SB_HIGHEST_VALID_MSGID lower limit is 1, up to CFE_SB_INVALID_MSG_ID - 1. ** ** When using the direct message map implementation for software bus routing, this @@ -176,7 +176,7 @@ ** When using the hash implementation for software bus routing, a multiple of the ** CFE_PLATFORM_SB_MAX_MSG_IDS is used to size the message map. In that case ** the range selected here does not impact message map memory use, so it's -** resonable to use up to the full range supported by the message ID implementation. +** reasonable to use up to the full range supported by the message ID implementation. */ #define CFE_PLATFORM_SB_HIGHEST_VALID_MSGID 0x1FFF @@ -240,7 +240,7 @@ ** \cfesbcfg SB Event Filtering ** ** \par Description: -** This group of configuration paramters dictates what SB events will be +** This group of configuration parameters dictates what SB events will be ** filtered through EVS. The filtering will begin after the SB task initializes ** and stay in effect until a cmd to EVS changes it. ** This allows the operator to set limits on the number of event messages that @@ -357,7 +357,7 @@ ** \par Description: ** Depending on the specific hardware system configuration, it may be possible ** to switch between a primary and redundant tone signal. If supported by -** hardware, this definitions will enable command interfaces to select the +** hardware, this definition will enable command interfaces to select the ** active tone signal. Both Time Clients and Time Servers support this feature. ** Note: Set the CFE_PLATFORM_TIME_CFG_SIGNAL define to true to enable tone signal commands. ** @@ -468,7 +468,7 @@ ** ** \par Description: ** Define Periodic Time to Update Local Clock Tone Latch. Applies only when -** in flywheel mode. This define dicates the period at which the simulated +** in flywheel mode. This define dictates the period at which the simulated ** 'last tone' time is updated. Units are seconds. ** ** \par Limits @@ -588,7 +588,7 @@ ** ** \par Limits ** There is a lower limit of 100 and an upper limit of 20000 on this -** configuration paramater. millisecond units. +** configuration parameter. millisecond units. */ #define CFE_PLATFORM_ES_APP_SCAN_RATE 1000 @@ -601,7 +601,7 @@ ** the signal Delete, Reload or Restart. The sequence works as follows: ** -# ES will set the control request for an App to Delete/Restart/Reload and ** set this kill timer to the value in this parameter. -** -# If the App is reponding and Calls it's RunLoop function, it will drop out +** -# If the App is responding and Calls it's RunLoop function, it will drop out ** of it's main loop and call CFE_ES_ExitApp. Once it calls Exit App, then ** ES can delete, restart, or reload the app the next time it scans the app ** table. @@ -617,7 +617,7 @@ ** ** \par Limits ** There is a lower limit of 1 and an upper limit of 100 on this configuration -** paramater. Units are number of #CFE_PLATFORM_ES_APP_SCAN_RATE cycles. +** parameter. Units are number of #CFE_PLATFORM_ES_APP_SCAN_RATE cycles. */ #define CFE_PLATFORM_ES_APP_KILL_TIMEOUT 5 @@ -676,7 +676,7 @@ ** ** \par Limits ** There is a lower limit of 0 and an upper limit of 75 on this configuration -** paramater.Units are percentage. A setting of zero will turn this feature +** parameter.Units are percentage. A setting of zero will turn this feature ** off. */ #define CFE_PLATFORM_ES_RAM_DISK_PERCENT_RESERVED 30 @@ -694,7 +694,7 @@ ** ** \par Limits ** There is a lower limit of 8192 and an upper limit of UINT_MAX (4 Gigabytes) -** on this configuration paramater. +** on this configuration parameter. */ #define CFE_PLATFORM_ES_CDS_SIZE (128 * 1024) @@ -714,7 +714,7 @@ ** ** \par Limits ** There is a lower limit of 1024 and an upper limit of UINT_MAX (4 Gigabytes) -** on this configuration paramater. +** on this configuration parameter. */ #define CFE_PLATFORM_ES_USER_RESERVED_SIZE (1024 * 1024) @@ -728,7 +728,7 @@ ** that are preserved during a processor reset. ** Note: This area must be sized large enough to hold all of the data ** structures. It should be automatically sized based on the CFE_ES_ResetData_t -** type, but circular dependancies in the headers prevent it from being defined +** type, but circular dependencies in the headers prevent it from being defined ** this way. ** NOTE: Changing this value changes memory allocation, and may ** require changes to platform specific values (in CFE_PSP) such as @@ -737,7 +737,7 @@ ** ** \par Limits ** There is a lower limit of 153600 (150KBytes) and an upper limit of UINT_MAX -** (4 Gigabytes) on this configuration paramater. +** (4 Gigabytes) on this configuration parameter. */ #define CFE_PLATFORM_ES_RESET_AREA_SIZE (170 * 1024) @@ -891,7 +891,7 @@ ** ** \par Limits ** There is a lower limit of 0 and an upper limit of 1 on this configuration -** paramater. +** parameter. */ #define CFE_PLATFORM_ES_DEFAULT_POR_SYSLOG_MODE 0 @@ -909,7 +909,7 @@ ** ** \par Limits ** There is a lower limit of 0 and an upper limit of 1 on this configuration -** paramater. +** parameter. */ #define CFE_PLATFORM_ES_DEFAULT_PR_SYSLOG_MODE 1 @@ -923,7 +923,7 @@ ** ** \par Limits ** There is a lower limit of 1025. There are no restrictions on the upper limit -** however, the maximum buffer size size is system dependent and should be verified. +** however, the maximum buffer size is system dependent and should be verified. ** The units are number of entries. An entry is defined by a 32 bit data word followed ** by a 64 bit time stamp. */ @@ -997,7 +997,7 @@ ** \cfeescfg Define Performance Analyzer Child Task Priority ** ** \par Description: -** This parameter defines the priority of the child task spawed by the +** This parameter defines the priority of the child task spawned by the ** Executive Services to write performance data to a file. Lower numbers ** are higher priority, with 1 being the highest priority in the case of a ** child task. @@ -1012,7 +1012,7 @@ ** \cfeescfg Define Performance Analyzer Child Task Stack Size ** ** \par Description: -** This parameter defines the stack size of the child task spawed by the +** This parameter defines the stack size of the child task spawned by the ** Executive Services to write performance data to a file. ** ** \par Limits @@ -1027,7 +1027,7 @@ ** ** \par Description: ** This parameter defines the delay time (in milliseconds) between performance -** data file writes performed by the Executive Services Performace Analyzer +** data file writes performed by the Executive Services Performance Analyzer ** Child Task. ** ** \par Limits @@ -1041,7 +1041,7 @@ ** \cfeescfg Define Performance Analyzer Child Task Number of Entries Between Delay ** ** \par Description: -** This parameter defines the number of performace analyzer entries the Performace +** This parameter defines the number of performance analyzer entries the Performance ** Analyzer Child Task will write to the file between delays. ** */ @@ -1056,7 +1056,7 @@ ** ** \par Limits ** There is a lower limit of 2048. There are no restrictions on the upper limit -** however, the maximum stack size size is system dependent and should be verified. +** however, the maximum stack size is system dependent and should be verified. ** Most operating systems provide tools for measuring the amount of stack used by a ** task during operation. It is always a good idea to verify that no more than 1/2 ** of the stack is used. @@ -1081,8 +1081,8 @@ ** Defines the cFE_EVS Task Stack Size ** ** \par Limits -** There is a lower limit of 2048 on this configuration paramater. There -** are no restrictions on the upper limit however, the maximum stack size size +** There is a lower limit of 2048 on this configuration parameter. There +** are no restrictions on the upper limit however, the maximum stack size ** is system dependent and should be verified. Most operating systems provide ** tools for measuring the amount of stack used by a task during operation. It ** is always a good idea to verify that no more than 1/2 of the stack is used. @@ -1107,8 +1107,8 @@ ** Defines the cFE_SB Task Stack Size ** ** \par Limits -** There is a lower limit of 2048 on this configuration paramater. There -** are no restrictions on the upper limit however, the maximum stack size size +** There is a lower limit of 2048 on this configuration parameter. There +** are no restrictions on the upper limit however, the maximum stack size ** is system dependent and should be verified. Most operating systems provide ** tools for measuring the amount of stack used by a task during operation. It ** is always a good idea to verify that no more than 1/2 of the stack is used. @@ -1133,8 +1133,8 @@ ** Defines the cFE_ES Task Stack Size ** ** \par Limits -** There is a lower limit of 2048 on this configuration paramater. There -** are no restrictions on the upper limit however, the maximum stack size size +** There is a lower limit of 2048 on this configuration parameter. There +** are no restrictions on the upper limit however, the maximum stack size ** is system dependent and should be verified. Most operating systems provide ** tools for measuring the amount of stack used by a task during operation. It ** is always a good idea to verify that no more than 1/2 of the stack is used. @@ -1151,7 +1151,7 @@ ** ** \par Limits ** There is a lower limit of zero and an upper limit of 255 on these -** configuration paramaters. Remember that the meaning of each task +** configuration parameters. Remember that the meaning of each task ** priority is inverted -- a "lower" number has a "higher" priority. */ #define CFE_PLATFORM_TIME_START_TASK_PRIORITY 60 @@ -1167,8 +1167,8 @@ ** Defines the cFE_TIME 1HZ Task Stack Size ** ** \par Limits -** There is a lower limit of 2048 on these configuration paramaters. There -** are no restrictions on the upper limit however, the maximum stack size size +** There is a lower limit of 2048 on these configuration parameters. There +** are no restrictions on the upper limit however, the maximum stack size ** is system dependent and should be verified. Most operating systems provide ** tools for measuring the amount of stack used by a task during operation. It ** is always a good idea to verify that no more than 1/2 of the stack is used. @@ -1195,8 +1195,8 @@ ** Defines the cFE_TBL Task Stack Size ** ** \par Limits -** There is a lower limit of 2048 on this configuration paramater. There -** are no restrictions on the upper limit however, the maximum stack size size +** There is a lower limit of 2048 on this configuration parameter. There +** are no restrictions on the upper limit however, the maximum stack size ** is system dependent and should be verified. Most operating systems provide ** tools for measuring the amount of stack used by a task during operation. It ** is always a good idea to verify that no more than 1/2 of the stack is used. @@ -1249,7 +1249,7 @@ /** \cfeescfg Maximum number of memory pools ** ** \par Description: -** The upper limit for the number of memory pools than can concurrently +** The upper limit for the number of memory pools that can concurrently ** exist within the system. ** ** The CFE_SB and CFE_TBL core subsystems each define a memory pool. @@ -1384,7 +1384,7 @@ ** \cfeevscfg Default EVS Output Port State ** ** \par Description: -** Defines the default port state (enabled or deisabled) for the four output +** Defines the default port state (enabled or disabled) for the four output ** ports defined within the Event Service. Port 1 is usually the uart output ** terminal. To enable a port, set the proper bit to a 1. Bit 0 is port 1, ** bit 1 is port2 etc. @@ -1670,7 +1670,7 @@ ** ** \par Description: ** The upper limit for the amount of time that the cFE core applications -** (ES, SB, EVS, TIME, TBL) are each alloted to reach their respective +** (ES, SB, EVS, TIME, TBL) are each allotted to reach their respective ** "ready" states. ** ** The CFE "main" thread starts individual tasks for each of the core applications @@ -1696,7 +1696,7 @@ ** The upper limit for the total amount of time that all apps listed in the CFE ES startup ** script may take to all become ready. ** -** Unlike the "core" app timeout, this is a soft limit; if the alloted time is exceeded, +** Unlike the "core" app timeout, this is a soft limit; if the allotted time is exceeded, ** it probably indicates an issue with one of the apps, but does not cause CFE ES to take ** any additional action other than logging the event to the syslog. ** diff --git a/cmake/sample_defs/native_osconfig.cmake b/cmake/sample_defs/native_osconfig.cmake index 07e53ea59..9cc252707 100644 --- a/cmake/sample_defs/native_osconfig.cmake +++ b/cmake/sample_defs/native_osconfig.cmake @@ -25,7 +25,7 @@ # # When building with SIMULATION=native, enable the PERMISSIVE option, # which allows for easier testing. This option causes the OSAL to -# continue through certain privleged operations (ignores errors) when +# continue through certain privileged operations (ignores errors) when # running as a standard/non-root user. # # Typically a regular user on a default Linux workstation configuration diff --git a/cmake/sample_defs/sample_mission_cfg.h b/cmake/sample_defs/sample_mission_cfg.h index 144a9d0f2..4c31cf7ef 100644 --- a/cmake/sample_defs/sample_mission_cfg.h +++ b/cmake/sample_defs/sample_mission_cfg.h @@ -123,7 +123,7 @@ ** ** For example, if the data packet follows the tone, it might be valid for ** the data packet to arrive between zero and 100,000 micro-seconds after -** the tone. But, if the tone follows the the packet, it might be valid +** the tone. But, if the tone follows the packet, it might be valid ** only if the packet arrived between 200,000 and 700,000 micro-seconds ** before the tone. ** @@ -284,7 +284,7 @@ ** \cfetblcfg Maximum Table Name Length ** ** \par Description: -** Indicates the maximum length (in characers) of the table name +** Indicates the maximum length (in characters) of the table name ** ('TblName') portion of a Full Table Name of the following ** form: "ApplicationName.TblName" ** @@ -446,7 +446,7 @@ ** \cfesbcfg Maximum Number of pipes that SB command/telemetry messages may hold ** ** \par Description: -** Dictates the maximum number of unique Pipes the SB message defintions will hold. +** Dictates the maximum number of unique Pipes the SB message definitions will hold. ** ** This affects the layout of command/telemetry messages but does not affect run ** time behavior or internal allocation. diff --git a/cmake/sample_defs/targets.cmake b/cmake/sample_defs/targets.cmake index 6301a0984..3b316170b 100644 --- a/cmake/sample_defs/targets.cmake +++ b/cmake/sample_defs/targets.cmake @@ -26,7 +26,7 @@ # My_C_Function_Name,MY_APP # The first item must be a publicly-exposed C symbol name available to # the linker at static link time, generally the entry point/main function -# of the a module or library (see STATIC_APPLIST). The second item is the +# of the module or library (see STATIC_APPLIST). The second item is the # module name that should match the name used in the CFE startup script # (4th parameter). # IMPORTANT: For this to work, the OS_STATIC_LOADER configuration option diff --git a/cmake/target/inc/target_config.h b/cmake/target/inc/target_config.h index 170a38f05..a6f7bf6c1 100644 --- a/cmake/target/inc/target_config.h +++ b/cmake/target/inc/target_config.h @@ -154,7 +154,7 @@ extern Target_CfeConfigData GLOBAL_CFE_CONFIGDATA; */ typedef const struct { - const char *MissionName; /**< The Mission Name from confguration */ + const char *MissionName; /**< The Mission Name from configuration */ /* * Note: the version strings in these fields should reflect the administratively-assigned diff --git a/cmake/target/src/target_config.c b/cmake/target/src/target_config.c index 956cdf7ab..ac974c3ca 100644 --- a/cmake/target/src/target_config.c +++ b/cmake/target/src/target_config.c @@ -112,7 +112,7 @@ extern CFE_ConfigKeyValue_t CFE_BUILD_ENV_TABLE[]; * * For dynamic modules, this means the version info can become outdated if/when * a single module is rebuilt/reloaded after the original CFE build. The keys in - * this table may be be checked against the CFE_STATIC_MODULE_LIST above to + * this table may be checked against the CFE_STATIC_MODULE_LIST above to * determine if static or dynamic linkage was used. In the case of dynamic linkage, * then this table only represents the version of the module that was present at the * time CFE was built, not necessarily the version on the target filesystem. diff --git a/modules/cfe_assert/inc/cfe_assert.h b/modules/cfe_assert/inc/cfe_assert.h index 4224e46a6..656be4b7f 100644 --- a/modules/cfe_assert/inc/cfe_assert.h +++ b/modules/cfe_assert/inc/cfe_assert.h @@ -98,7 +98,7 @@ typedef void (*CFE_Assert_StatusCallback_t)(uint8 MessageType, const char *Prefi ** ** \par Assumptions, External Events, and Notes: ** The generic #UtAssert_UINT32_EQ check should not be used, as ID values -** and integers may not be interchangable with strict type checking. +** and integers may not be interchangeable with strict type checking. ** ******************************************************************************/ #define CFE_UtAssert_RESOURCEID_EQ(id1, id2) \ @@ -144,7 +144,7 @@ typedef void (*CFE_Assert_StatusCallback_t)(uint8 MessageType, const char *Prefi ** ** \par Assumptions, External Events, and Notes: ** The generic #UtAssert_UINT32_EQ check should not be used, as CFE_SB_MsgId_t values -** and integers may not be interchangable with strict type checking. +** and integers may not be interchangeable with strict type checking. ** ******************************************************************************/ #define CFE_UtAssert_MSGID_EQ(mid1, mid2) \ diff --git a/modules/cfe_testcase/src/msg_api_test.c b/modules/cfe_testcase/src/msg_api_test.c index 0690ef07a..335150695 100644 --- a/modules/cfe_testcase/src/msg_api_test.c +++ b/modules/cfe_testcase/src/msg_api_test.c @@ -104,7 +104,7 @@ void TestMsgApiBasic(void) UtAssert_INT32_EQ(CFE_MSG_GetHeaderVersion(&cmd.Msg, &hdrVer), CFE_SUCCESS); UtAssert_True(hdrVer == 0, "hdrVer = 0"); - /* test get-has-secondary-header and set-has-scondary-header*/ + /* test get-has-secondary-header and set-has-secondary-header*/ UtAssert_INT32_EQ(CFE_MSG_GetHasSecondaryHeader(NULL, &_expected), CFE_MSG_BAD_ARGUMENT); UtAssert_INT32_EQ(CFE_MSG_GetHasSecondaryHeader(&cmd.Msg, NULL), CFE_MSG_BAD_ARGUMENT); UtAssert_INT32_EQ(CFE_MSG_SetHasSecondaryHeader(NULL, _expected), CFE_MSG_BAD_ARGUMENT); diff --git a/modules/cfe_testcase/src/sb_pipe_mang_test.c b/modules/cfe_testcase/src/sb_pipe_mang_test.c index da161d2dd..79d991c71 100644 --- a/modules/cfe_testcase/src/sb_pipe_mang_test.c +++ b/modules/cfe_testcase/src/sb_pipe_mang_test.c @@ -21,7 +21,7 @@ ** File: sb_pipe_mang_test.c ** ** Purpose: -** Functional test of Sb Pipe Managment APIs +** Functional test of Sb Pipe Management APIs ** ** Demonstration of how to register and use the UT assert functions. ** diff --git a/modules/cfe_testcase/src/tbl_content_access_test.c b/modules/cfe_testcase/src/tbl_content_access_test.c index 08c60e868..e0621621f 100644 --- a/modules/cfe_testcase/src/tbl_content_access_test.c +++ b/modules/cfe_testcase/src/tbl_content_access_test.c @@ -96,7 +96,7 @@ void TestReleaseAddress(void) /* Release and try again */ UtAssert_INT32_EQ(CFE_TBL_ReleaseAddress(CFE_FT_Global.TblHandle), CFE_SUCCESS); /* It is necessary to call CFE_TBL_Manage because the table still thinks there is a load in progress from the failed - load while the table was locked. This call shouldn't be necesssary. */ + load while the table was locked. This call shouldn't be necessary. */ UtAssert_INT32_EQ(CFE_TBL_Manage(CFE_FT_Global.TblHandle), CFE_TBL_INFO_UPDATED); LoadTable(&TestTable, CFE_SUCCESS); diff --git a/modules/cfe_testcase/src/time_misc_test.c b/modules/cfe_testcase/src/time_misc_test.c index 2a84b3bad..484ffee21 100644 --- a/modules/cfe_testcase/src/time_misc_test.c +++ b/modules/cfe_testcase/src/time_misc_test.c @@ -21,7 +21,7 @@ ** File: time_misc_test.c ** ** Purpose: -** Functional test of miscelaneous Time APIs +** Functional test of miscellaneous Time APIs ** ** Demonstration of how to register and use the UT assert functions. ** diff --git a/modules/core_api/fsw/inc/cfe_endian.h b/modules/core_api/fsw/inc/cfe_endian.h index 16f578631..3d7701bb8 100644 --- a/modules/core_api/fsw/inc/cfe_endian.h +++ b/modules/core_api/fsw/inc/cfe_endian.h @@ -37,7 +37,7 @@ /* * SOFTWARE_BIG/LITTLE_BIT_ORDER COMPATIBILITY MACRO - * - * This is provided only for backward compatibilty. Do not write any new code that + * This is provided only for backward compatibility. Do not write any new code that * uses this macro. */ #if !defined(SOFTWARE_BIG_BIT_ORDER) && !defined(SOFTWARE_LITTLE_BIT_ORDER) diff --git a/modules/core_api/fsw/inc/cfe_error.h b/modules/core_api/fsw/inc/cfe_error.h index 8f4ced247..24d47baa6 100644 --- a/modules/core_api/fsw/inc/cfe_error.h +++ b/modules/core_api/fsw/inc/cfe_error.h @@ -113,7 +113,7 @@ typedef int32 CFE_Status_t; */ /** - * @brief Sucessful execution + * @brief Successful execution * * Operation was performed successfully */ @@ -342,7 +342,7 @@ typedef int32 CFE_Status_t; /** * @brief Child Task Register Error * - * Errors occured when trying to register a child task. + * Errors occurred when trying to register a child task. * */ #define CFE_ES_ERR_CHILD_TASK_REGISTER ((CFE_Status_t)0xc400000b) @@ -468,7 +468,7 @@ typedef int32 CFE_Status_t; #define CFE_ES_BIN_SEM_DELETE_ERR ((CFE_Status_t)0xc400001C) /** - * @brief Counte Semaphore Delete Error + * @brief Counting Semaphore Delete Error * * Occurs when trying to delete a Counting Semaphore that belongs to a task that ES * is cleaning up. @@ -694,7 +694,7 @@ typedef int32 CFE_Status_t; * @brief Max Pipes Met * * This error code will be returned from #CFE_SB_CreatePipe when the - * SB cannot accomodate the request to create a pipe because the maximum + * SB cannot accommodate the request to create a pipe because the maximum * number of pipes (#CFE_PLATFORM_SB_MAX_PIPES) are in use. This configuration * parameter is defined in the cfe_platform_cfg.h file. * @@ -752,7 +752,7 @@ typedef int32 CFE_Status_t; * @brief Max Messages Met * * Will be returned when calling one of the SB subscription API's if the - * SB routing table cannot accomodate another unique message ID because + * SB routing table cannot accommodate another unique message ID because * the platform configuration parameter #CFE_PLATFORM_SB_MAX_MSG_IDS has been met. * */ @@ -762,7 +762,7 @@ typedef int32 CFE_Status_t; * @brief Max Destinations Met * * Will be returned when calling one of the SB subscription API's if the - * SB routing table cannot accomodate another destination for a + * SB routing table cannot accommodate another destination for a * particular the given message ID. This occurs when the number of * destinations in use meets the platform configuration parameter * #CFE_PLATFORM_SB_MAX_DEST_PER_PKT. @@ -918,7 +918,7 @@ typedef int32 CFE_Status_t; #define CFE_TBL_ERR_DUPLICATE_DIFF_SIZE ((CFE_Status_t)0xcc00000C) /** - * @brief Dupicate Table And Not Owned + * @brief Duplicate Table And Not Owned * * An application attempted to register a table with the same name * as a table that is already in the registry. The previously registered @@ -1102,7 +1102,7 @@ typedef int32 CFE_Status_t; * @brief Partial Load Warning * * The calling Application tried to load a table file whose header - * claimed the load did not start with the first byteIt should be noted + * claimed the load did not start with the first byte. It should be noted * that #CFE_TBL_WARN_SHORT_FILE also indicates a partial load. * */ diff --git a/modules/core_api/fsw/inc/cfe_es.h b/modules/core_api/fsw/inc/cfe_es.h index 44e6e79c3..28c91f804 100644 --- a/modules/core_api/fsw/inc/cfe_es.h +++ b/modules/core_api/fsw/inc/cfe_es.h @@ -129,7 +129,7 @@ int32 CFE_ES_LibID_ToIndex(CFE_ES_LibId_t LibId, uint32 *Idx); * * Index values are only guaranteed to be unique for resources of the same * type. For instance, the indices corresponding to two [valid] Task - * IDs will never overlap, but the index of an Task and a library ID + * IDs will never overlap, but the index of a Task and a library ID * may be the same. Furthermore, indices may be reused if a resource is * deleted and re-created. * @@ -155,7 +155,7 @@ CFE_Status_t CFE_ES_TaskID_ToIndex(CFE_ES_TaskId_t TaskID, uint32 *Idx); * * Index values are only guaranteed to be unique for resources of the same * type. For instance, the indices corresponding to two [valid] Counter - * IDs will never overlap, but the index of an Counter and a library ID + * IDs will never overlap, but the index of a Counter and a library ID * may be the same. Furthermore, indices may be reused if a resource is * deleted and re-created. * @@ -246,7 +246,7 @@ CFE_Status_t CFE_ES_ResetCFE(uint32 ResetType); ** from the same file name as the last start. ** ** \par Assumptions, External Events, and Notes: -** The filename is checked for existance prior to load. A missing file +** The filename is checked for existence prior to load. A missing file ** will be reported and the reload operation will be aborted prior ** to unloading the app. ** @@ -281,7 +281,7 @@ CFE_Status_t CFE_ES_RestartApp(CFE_ES_AppId_t AppID); ** the specified file. ** ** \par Assumptions, External Events, and Notes: -** The filename is checked for existance prior to load. A missing file +** The filename is checked for existence prior to load. A missing file ** will be reported and the reload operation will be aborted prior ** to unloading the app. ** @@ -471,7 +471,7 @@ void CFE_ES_WaitForStartupSync(uint32 TimeOutMilliseconds); ** the counter for the Application. ** ** \par Assumptions, External Events, and Notes: -** NOTE: This API is not needed for Appplications that call the CFE_ES_RunLoop call. +** NOTE: This API is not needed for Applications that call the CFE_ES_RunLoop call. ** ** \sa #CFE_ES_RunLoop ** @@ -845,7 +845,7 @@ CFE_Status_t CFE_ES_CreateChildTask(CFE_ES_TaskId_t *TaskIdPtr, const char *Task ** None ** ** \param[out] TaskIdPtr Pointer to variable that is to receive the Task's ID @nonnull. -** \param[in] TaskName Pointer to null terminated character string containing an Task name @nonnull. +** \param[in] TaskName Pointer to null terminated character string containing a Task name @nonnull. ** ** \return Execution status, see \ref CFEReturnCodes ** \retval #CFE_SUCCESS \copybrief CFE_SUCCESS @@ -1511,7 +1511,7 @@ CFE_Status_t CFE_ES_GetMemPoolStats(CFE_ES_MemPoolStats_t *BufPtr, CFE_ES_MemHan ** depending on the value of the DataCount ** ** Time is stored as 2 32 bit integers, (TimerLower32, TimerUpper32): -** TimerLower32 is the curent value of the hardware timer register. +** TimerLower32 is the current value of the hardware timer register. ** TimerUpper32 is the number of times the timer has rolled over. ** ** \param[in] Marker Identifier of the specific event or marker. diff --git a/modules/core_api/fsw/inc/cfe_es_api_typedefs.h b/modules/core_api/fsw/inc/cfe_es_api_typedefs.h index d8edef745..fa799adad 100644 --- a/modules/core_api/fsw/inc/cfe_es_api_typedefs.h +++ b/modules/core_api/fsw/inc/cfe_es_api_typedefs.h @@ -86,7 +86,7 @@ typedef CFE_ES_TaskEntryFuncPtr_t CFE_ES_ChildTaskMainFuncPtr_t; typedef void *CFE_ES_StackPointer_t; /* aka osal_stackptr_t in proposed OSAL change */ /** - * \brief Pool Alignement + * \brief Pool Alignment * * Union that can be used for minimum memory alignment of ES memory pools on the target. * It contains the longest native data types such that the alignment of this structure @@ -164,7 +164,7 @@ typedef void *CFE_ES_MemPoolBuf_t; /** \} */ -/** \name Type-specific initalizers for "undefined" resource IDs */ +/** \name Type-specific initializers for "undefined" resource IDs */ /** \{ */ #define CFE_ES_APPID_UNDEFINED CFE_ES_APPID_C(CFE_RESOURCEID_UNDEFINED) diff --git a/modules/core_api/fsw/inc/cfe_es_extern_typedefs.h b/modules/core_api/fsw/inc/cfe_es_extern_typedefs.h index b0c70194b..0d1949c27 100644 --- a/modules/core_api/fsw/inc/cfe_es_extern_typedefs.h +++ b/modules/core_api/fsw/inc/cfe_es_extern_typedefs.h @@ -347,7 +347,7 @@ typedef CFE_RESOURCEID_BASE_TYPE CFE_ES_LibId_t; /** * @brief A type for Counter IDs * - * This is the type that is used for any API accepting or returning an Counter ID + * This is the type that is used for any API accepting or returning a Counter ID */ typedef CFE_RESOURCEID_BASE_TYPE CFE_ES_CounterId_t; @@ -391,7 +391,7 @@ typedef uint16 CFE_ES_TaskPriority_Atom_t; typedef uint32 CFE_ES_MemOffset_t; /* - * A converter macro to use when initializing an CFE_ES_MemOffset_t + * A converter macro to use when initializing a CFE_ES_MemOffset_t * from an integer value of a different type. */ #define CFE_ES_MEMOFFSET_C(x) ((CFE_ES_MemOffset_t)(x)) @@ -418,7 +418,7 @@ typedef uint32 CFE_ES_MemOffset_t; typedef uint32 CFE_ES_MemAddress_t; /* - * A converter macro to use when initializing an CFE_ES_MemAddress_t + * A converter macro to use when initializing a CFE_ES_MemAddress_t * from a pointer value of a different type. * * @note on a 64 bit platform, this macro will truncate the address such @@ -428,7 +428,7 @@ typedef uint32 CFE_ES_MemAddress_t; #define CFE_ES_MEMADDRESS_C(x) ((CFE_ES_MemAddress_t)((cpuaddr)(x)&0xFFFFFFFF)) /* - * Data Sructures shared between API and Message (CMD/TLM) interfaces + * Data Structures shared between API and Message (CMD/TLM) interfaces */ /** diff --git a/modules/core_api/fsw/inc/cfe_evs.h b/modules/core_api/fsw/inc/cfe_evs.h index 1bef0d83a..37805c57e 100644 --- a/modules/core_api/fsw/inc/cfe_evs.h +++ b/modules/core_api/fsw/inc/cfe_evs.h @@ -121,7 +121,7 @@ CFE_Status_t CFE_EVS_Register(const void *Filters, uint16 NumEventFilters, uint1 ** ** \par Assumptions, External Events, and Notes: ** This API only works within the context of a registered application or core service. -** For messages outside the context of a registered appliction (for example early +** For messages outside the context of a registered application (for example early ** in app initialization or if registration fails) #CFE_ES_WriteToSysLog can be used ** for reporting. ** @@ -168,7 +168,7 @@ CFE_Status_t CFE_EVS_SendEvent(uint16 EventID, uint16 EventType, const char *Spe ** ** \par Assumptions, External Events, and Notes: ** The Application ID must correspond to a registered application or core service. -** For messages outside the context of a registered appliction (for example early +** For messages outside the context of a registered application (for example early ** in app initialization or if registration fails) #CFE_ES_WriteToSysLog can be used ** for reporting. ** @@ -217,7 +217,7 @@ CFE_Status_t CFE_EVS_SendEventWithAppID(uint16 EventID, uint16 EventType, CFE_ES ** ** \par Assumptions, External Events, and Notes: ** This API only works within the context of a registered application or core service. -** For messages outside the context of a registered appliction (for example early +** For messages outside the context of a registered application (for example early ** in app initialization or if registration fails) #CFE_ES_WriteToSysLog can be used ** for reporting. ** diff --git a/modules/core_api/fsw/inc/cfe_evs_api_typedefs.h b/modules/core_api/fsw/inc/cfe_evs_api_typedefs.h index 0594c2067..76d9a0dc8 100644 --- a/modules/core_api/fsw/inc/cfe_evs_api_typedefs.h +++ b/modules/core_api/fsw/inc/cfe_evs_api_typedefs.h @@ -58,7 +58,7 @@ /****************** Structure Definitions *********************/ -/** \brief Event message filter defintion structure */ +/** \brief Event message filter definition structure */ typedef struct CFE_EVS_BinFilter { uint16 EventID; /**< \brief Numerical event identifier */ diff --git a/modules/core_api/fsw/inc/cfe_fs_api_typedefs.h b/modules/core_api/fsw/inc/cfe_fs_api_typedefs.h index 604c1ffb8..c3d952a7c 100644 --- a/modules/core_api/fsw/inc/cfe_fs_api_typedefs.h +++ b/modules/core_api/fsw/inc/cfe_fs_api_typedefs.h @@ -95,7 +95,7 @@ typedef enum * \retval false if not at last record, more data records to write * * \note The implementation of this function must always set the "Buffer" and "BufSize" outputs. If - * no data is avaliable, they may be set to NULL and 0, respectively. + * no data is available, they may be set to NULL and 0, respectively. */ typedef bool (*CFE_FS_FileWriteGetData_t)(void *Meta, uint32 RecordNum, void **Buffer, size_t *BufSize); @@ -109,7 +109,7 @@ typedef bool (*CFE_FS_FileWriteGetData_t)(void *Meta, uint32 RecordNum, void **B * \param[in] Event Generalized type of event to report (not actual event ID) * \param[in] Status Generalized status code (may be from OSAL or CFE) * \param[in] RecordNum Record number counter at which event occurred - * \param[in] BlockSize Size of record being processed when event occured (if applicable) + * \param[in] BlockSize Size of record being processed when event occurred (if applicable) * \param[in] Position File position/size when event occurred * */ diff --git a/modules/core_api/fsw/inc/cfe_msg.h b/modules/core_api/fsw/inc/cfe_msg.h index 4b8cb3c0c..b8f5b6348 100644 --- a/modules/core_api/fsw/inc/cfe_msg.h +++ b/modules/core_api/fsw/inc/cfe_msg.h @@ -54,7 +54,7 @@ * * \param[out] MsgPtr A pointer to the buffer that contains the message @nonnull. * \param[in] MsgId MsgId that corresponds to message - * \param[in] Size Total size of the mesage (used to set length field) + * \param[in] Size Total size of the message (used to set length field) * * \return Execution status, see \ref CFEReturnCodes * \retval #CFE_SUCCESS \copybrief CFE_SUCCESS @@ -185,7 +185,7 @@ CFE_Status_t CFE_MSG_GetHasSecondaryHeader(const CFE_MSG_Message_t *MsgPtr, bool * \brief Sets the message secondary header boolean * * \par Description - * This routine sets the message has secondary header boolean. Typically only + * This routine sets the message secondary header boolean. Typically only * set within message initialization and not used by APPs. * * \param[in, out] MsgPtr A pointer to the buffer that contains the message @nonnull. diff --git a/modules/core_api/fsw/inc/cfe_msg_api_typedefs.h b/modules/core_api/fsw/inc/cfe_msg_api_typedefs.h index 43e89510c..ff3fc833f 100644 --- a/modules/core_api/fsw/inc/cfe_msg_api_typedefs.h +++ b/modules/core_api/fsw/inc/cfe_msg_api_typedefs.h @@ -70,7 +70,7 @@ typedef enum CFE_MSG_SegmentationFlag CFE_MSG_SegFlag_Continue, /**< \brief Continuation segment of User Data */ CFE_MSG_SegFlag_First, /**< \brief First segment of User Data */ CFE_MSG_SegFlag_Last, /**< \brief Last segment of User Data */ - CFE_MSG_SegFlag_Unsegmented /**< \brief Unsegemented data */ + CFE_MSG_SegFlag_Unsegmented /**< \brief Unsegmented data */ } CFE_MSG_SegmentationFlag_t; /** \brief Endian flag */ @@ -93,7 +93,7 @@ typedef enum CFE_MSG_PlaybackFlag * Abstract Message Base Types * * The concrete definition of these is provided by "cfe_msg_hdr.h" which is - * user-selectable depending on the actual desired message defintion. These + * user-selectable depending on the actual desired message definition. These * abstract types are used in the API definition; the API is defined based * on these abstract types, independent of the actual message definition. */ diff --git a/modules/core_api/fsw/inc/cfe_sb.h b/modules/core_api/fsw/inc/cfe_sb.h index 6f11d8029..4e88f184b 100644 --- a/modules/core_api/fsw/inc/cfe_sb.h +++ b/modules/core_api/fsw/inc/cfe_sb.h @@ -442,7 +442,7 @@ CFE_Status_t CFE_SB_TransmitMsg(const CFE_MSG_Message_t *MsgPtr, bool IncrementS ** \param[in, out] BufPtr A pointer to the software bus buffer to receive to @nonnull. ** Typically a caller declares a ptr of type CFE_SB_Buffer_t ** (i.e. CFE_SB_Buffer_t *Ptr) then gives the address of that -** pointer (&Ptr) as this parmeter. After a successful +** pointer (&Ptr) as this parameter. After a successful ** receipt of a message, *BufPtr will point to the first ** byte of the software bus buffer. This should be ** used as a read-only pointer (in systems with an MMU, @@ -544,7 +544,7 @@ CFE_Status_t CFE_SB_ReleaseMessageBuffer(CFE_SB_Buffer_t *BufPtr); ** -# If this function returns CFE_SUCCESS, this indicates the zero copy handle is ** now owned by software bus, and is no longer owned by the calling application, ** and should not be re-used. -** -# Howver if this function fails (returns any error status) it does not change +** -# However if this function fails (returns any error status) it does not change ** the state of the buffer at all, meaning the calling application still owns it. ** (a failure means the buffer is left in the same state it was before the call). ** -# Applications should be written as if #CFE_SB_AllocateMessageBuffer is @@ -699,7 +699,7 @@ size_t CFE_SB_GetUserDataLength(const CFE_MSG_Message_t *MsgPtr); ** when copying strings out of software bus messages to local storage buffers. ** ** Up to [SourceMaxSize] or [DestMaxSize-1] (whichever is smaller) characters will be -** coped from the source buffer to the destination buffer, and a NUL termination +** copied from the source buffer to the destination buffer, and a NUL termination ** character will be written to the destination buffer as the last character. ** ** If the DefaultString pointer is non-NULL, it will be used in place of the source diff --git a/modules/core_api/fsw/inc/cfe_sb_extern_typedefs.h b/modules/core_api/fsw/inc/cfe_sb_extern_typedefs.h index ae115a7ca..3ccf2f8f9 100644 --- a/modules/core_api/fsw/inc/cfe_sb_extern_typedefs.h +++ b/modules/core_api/fsw/inc/cfe_sb_extern_typedefs.h @@ -61,7 +61,7 @@ enum CFE_SB_QosPriority }; /** - * @brief Selects the priorty level for message routing + * @brief Selects the priority level for message routing * * @sa enum CFE_SB_QosPriority */ diff --git a/modules/core_api/fsw/inc/cfe_tbl.h b/modules/core_api/fsw/inc/cfe_tbl.h index 277c62984..167af8279 100644 --- a/modules/core_api/fsw/inc/cfe_tbl.h +++ b/modules/core_api/fsw/inc/cfe_tbl.h @@ -67,7 +67,7 @@ ** \param[out] TblHandlePtr a pointer to a #CFE_TBL_Handle_t type variable @nonnull that will be assigned the table's ** handle. The table handle is required for other API calls when accessing the data ** contained in the table. *TblHandlePtr is the handle used to identify table to cFE -** when performing Table operations. This value is returned at ddress specified by +** when performing Table operations. This value is returned at address specified by ** TblHandlePtr. ** ** \param[in] Name The raw table name. This name will be combined with the name of the @@ -142,7 +142,7 @@ ** exclusive of the #CFE_TBL_OPT_DBL_BUFFER option. ** \arg #CFE_TBL_OPT_CRITICAL- When this option is selected, the Table Service ** will automatically allocate space in the Critical -** Data Store (CDS) for the table and insure that the +** Data Store (CDS) for the table and ensure that the ** contents in the CDS are the same ** as the contents of the currently active buffer for ** the table. This option is mutually exclusive of the @@ -245,7 +245,7 @@ CFE_Status_t CFE_TBL_Share(CFE_TBL_Handle_t *TblHandlePtr, const char *TblName); ** registration/unregistration by the owning application during operation ** should be avoided. If unavoidable, special care needs to be taken ** (especially for shared tables) to avoid race conditions due to -** competing requests from mutiple tasks. +** competing requests from multiple tasks. ** ** Note the table will not be removed from memory until all table access ** links have been removed (registration and all shared access). @@ -493,7 +493,7 @@ CFE_Status_t CFE_TBL_Modified(CFE_TBL_Handle_t TblHandle); ** -# #CFE_TBL_ERR_NEVER_LOADED will be returned if the table has never been ** loaded (either from file or from a block of memory), but the function ** will still return a valid table pointer to a table with all zero content. -** This pointer mush be released with the #CFE_TBL_ReleaseAddress API before +** This pointer must be released with the #CFE_TBL_ReleaseAddress API before ** the table can be loaded with data. ** ** \param[out] TblPtr The address of a pointer @nonnull that will be loaded with the address of @@ -573,7 +573,7 @@ CFE_Status_t CFE_TBL_ReleaseAddress(CFE_TBL_Handle_t TblHandle); ** -# #CFE_TBL_ERR_NEVER_LOADED will be returned if the table has never been ** loaded (either from file or from a block of memory), but the function ** will still return a valid table pointer to a table with all zero content. -** This pointer mush be released with the #CFE_TBL_ReleaseAddress API before +** This pointer must be released with the #CFE_TBL_ReleaseAddress API before ** the table can be loaded with data. ** ** \param[out] TblPtrs Array of Pointers @nonnull to variables that calling Application diff --git a/modules/core_api/fsw/inc/cfe_tbl_extern_typedefs.h b/modules/core_api/fsw/inc/cfe_tbl_extern_typedefs.h index 08182786e..79ffd663d 100644 --- a/modules/core_api/fsw/inc/cfe_tbl_extern_typedefs.h +++ b/modules/core_api/fsw/inc/cfe_tbl_extern_typedefs.h @@ -68,7 +68,7 @@ typedef uint16 CFE_TBL_BufferSelect_Enum_t; /** * @brief The definition of the header fields that are included in CFE Table Data files. * - * This header follows the CFE_FS header and precedes the the actual table data. + * This header follows the CFE_FS header and precedes the actual table data. */ typedef struct CFE_TBL_File_Hdr { diff --git a/modules/core_api/fsw/inc/cfe_time.h b/modules/core_api/fsw/inc/cfe_time.h index a13e71e35..dcdd4389f 100644 --- a/modules/core_api/fsw/inc/cfe_time.h +++ b/modules/core_api/fsw/inc/cfe_time.h @@ -407,7 +407,7 @@ CFE_TIME_Compare_t CFE_TIME_Compare(CFE_TIME_SysTime_t TimeA, CFE_TIME_SysTime_t ** ** \par Description ** This function returns Spacecraft Time given MET. Note that Spacecraft -** Time is returned as either UTC or TAI depeneding on whether the mission +** Time is returned as either UTC or TAI depending on whether the mission ** configuration parameter #CFE_MISSION_TIME_CFG_DEFAULT_UTC or #CFE_MISSION_TIME_CFG_DEFAULT_TAI ** was set to true at compile time. ** @@ -478,7 +478,7 @@ uint32 CFE_TIME_Micro2SubSecs(uint32 MicroSeconds); ** ** \par Description ** This routine provides a method for cFE TIME software to be notified -** of the occurance of the 1Hz tone signal without knowledge of the +** of the occurrence of the 1Hz tone signal without knowledge of the ** specific hardware design. Regardless of the source of the tone, ** this routine should be called as soon as possible after detection ** to allow cFE TIME software the opportunity to latch the local clock @@ -603,7 +603,7 @@ void CFE_TIME_ExternalGPS(CFE_TIME_SysTime_t NewTime, int16 NewLeaps); ** \par Assumptions, External Events, and Notes: ** - This routine is included in the API only when 3 specific configuration ** parameters are set to true. The first is #CFE_PLATFORM_TIME_CFG_SERVER which defines this -** instanciation of cFE TIME as a time server (not a client). The second +** instantiation of cFE TIME as a time server (not a client). The second ** required configuration parameter is #CFE_PLATFORM_TIME_CFG_SOURCE which enables ** time source selection commands to the cFE TIME task, and further enables ** configuration definitions for the selected type of external time data. diff --git a/modules/core_api/fsw/inc/cfe_time_extern_typedefs.h b/modules/core_api/fsw/inc/cfe_time_extern_typedefs.h index 7a2aeb126..ac527cca8 100644 --- a/modules/core_api/fsw/inc/cfe_time_extern_typedefs.h +++ b/modules/core_api/fsw/inc/cfe_time_extern_typedefs.h @@ -166,7 +166,7 @@ enum CFE_TIME_ClockState * \par Description * The #CFE_TIME_ClockState_Enum_t enumerations identify the three recognized states of the current time. * If the clock has never been successfully synchronized with the primary onboard clock source, the - * time is conisdered to be #CFE_TIME_ClockState_INVALID. If the time is currently synchronized (i.e. - the + * time is considered to be #CFE_TIME_ClockState_INVALID. If the time is currently synchronized (i.e. - the * primary synchronization mechanism has not been dropped for any significant amount of time), then * the current time is considered to be #CFE_TIME_ClockState_VALID. If the time had, at some point in the past, * been synchronized, but the synchronization with the primary onboard clock has since been lost, then diff --git a/modules/core_api/fsw/inc/cfe_version.h b/modules/core_api/fsw/inc/cfe_version.h index cb02cfc46..f8926e5f3 100644 --- a/modules/core_api/fsw/inc/cfe_version.h +++ b/modules/core_api/fsw/inc/cfe_version.h @@ -37,7 +37,7 @@ #define CFE_REVISION 99 /**< @brief Revision, 99 indicates development */ #define CFE_MISSION_REV 0 /**< @brief Mission revision, reserved for mission use */ -#define CFE_STR_HELPER(x) #x /**< @brief Convert agrument to string */ +#define CFE_STR_HELPER(x) #x /**< @brief Convert argument to string */ #define CFE_STR(x) CFE_STR_HELPER(x) /**< @brief Expand macro before conversion */ /** diff --git a/modules/core_api/ut-stubs/src/cfe_es_handlers.c b/modules/core_api/ut-stubs/src/cfe_es_handlers.c index 3c58fc82c..f240b58bf 100644 --- a/modules/core_api/ut-stubs/src/cfe_es_handlers.c +++ b/modules/core_api/ut-stubs/src/cfe_es_handlers.c @@ -375,7 +375,7 @@ void UT_DefaultHandler_CFE_ES_GetPoolBuf(void *UserObj, UT_EntryKey_t FuncKey, c else { /* - * This a a bug in the test case. + * This is a bug in the test case. * * The buffer is insufficient, so the test case must * use UT_SetDataBuffer() to register a pool buffer that is diff --git a/modules/core_private/fsw/inc/cfe_core_resourceid_basevalues.h b/modules/core_private/fsw/inc/cfe_core_resourceid_basevalues.h index a1289b5e0..8991a1d78 100644 --- a/modules/core_private/fsw/inc/cfe_core_resourceid_basevalues.h +++ b/modules/core_private/fsw/inc/cfe_core_resourceid_basevalues.h @@ -44,7 +44,7 @@ * Assign unique offsets per resource types used in CFE core apps. * * Applications should not use these values directly, but rather - * in conjuction with the CFE_RESOURCEID_MAKE_BASE macro provided + * in conjunction with the CFE_RESOURCEID_MAKE_BASE macro provided * by the Resource ID module. (see below) */ enum @@ -74,7 +74,7 @@ enum /* * Assign actual base values from the offsets above * - * Using "enum" ensures these are resolved as integers now, as opposed at to the point of use like macros. + * Using "enum" ensures these are resolved as integers now, as opposed to at the point of use like macros. */ enum { diff --git a/modules/core_private/fsw/inc/cfe_sbr.h b/modules/core_private/fsw/inc/cfe_sbr.h index 2b351b74b..513286360 100644 --- a/modules/core_private/fsw/inc/cfe_sbr.h +++ b/modules/core_private/fsw/inc/cfe_sbr.h @@ -119,7 +119,7 @@ CFE_MSG_SequenceCount_t CFE_SBR_GetSequenceCounter(CFE_SBR_RouteId_t RouteId); * \brief Call the supplied callback function for all routes * * Invokes callback for each route in the table. Message ID order - * depends on the routing table implementation. Possiblities include + * depends on the routing table implementation. Possibilities include * in subscription order and in order if incrementing message ids. * * \param[in] CallbackPtr Function to invoke for each matching ID diff --git a/modules/core_private/ut-stubs/inc/ut_support.h b/modules/core_private/ut-stubs/inc/ut_support.h index 03e6d10a2..8e65cfe0f 100644 --- a/modules/core_private/ut-stubs/inc/ut_support.h +++ b/modules/core_private/ut-stubs/inc/ut_support.h @@ -67,7 +67,7 @@ extern const char *UT_OSP_MESSAGES[]; #define UT_ADD_TEST(Func) UtTest_Add(Func, NULL, NULL, #Func) /* Required to be defined for GetMsgId and SetMsgId stubs - * Actual macro defitiions are in cfe_sb_msg_id_utils.h + * Actual macro definitions are in cfe_sb_msg_id_utils.h * #ifndef so that the actual macros are used for unit * testing of SB * */ @@ -528,7 +528,7 @@ void UT_DisplayPkt(CFE_MSG_Message_t *MsgPtr, size_t size); ** \brief Gets a reference to the CFE ES Reset Data Object ** ** \par Description -** Some CFE test casess may need to check or modify the reset data +** Some CFE test cases may need to check or modify the reset data ** that is maintained by CFE ES. ** ** \par Assumptions, External Events, and Notes: @@ -728,7 +728,7 @@ bool CFE_UtAssert_MessageCheck_Impl(bool Status, const char *File, uint32 Line, ** ** \par Assumptions, External Events, and Notes: ** The generic #UtAssert_UINT32_EQ check should not be used, as ID values -** and integers may not be interchangable with strict type checking. +** and integers may not be interchangeable with strict type checking. ** ******************************************************************************/ #define CFE_UtAssert_RESOURCEID_EQ(id1, id2) \ @@ -759,7 +759,7 @@ bool CFE_UtAssert_MessageCheck_Impl(bool Status, const char *File, uint32 Line, ** ** \par Assumptions, External Events, and Notes: ** The generic #UtAssert_UINT32_EQ check should not be used, as CFE_SB_MsgId_t values -** and integers may not be interchangable with strict type checking. +** and integers may not be interchangeable with strict type checking. ** ******************************************************************************/ #define CFE_UtAssert_MSGID_EQ(mid1, mid2) \ diff --git a/modules/es/fsw/inc/cfe_es_events.h b/modules/es/fsw/inc/cfe_es_events.h index 910eb93f9..19bcc7bbf 100644 --- a/modules/es/fsw/inc/cfe_es_events.h +++ b/modules/es/fsw/inc/cfe_es_events.h @@ -314,7 +314,7 @@ * * \par Cause: * - * \link #CFE_ES_START_APP_CC ES Start Application Command \endlink falure due to + * \link #CFE_ES_START_APP_CC ES Start Application Command \endlink failure due to * invalid filename. */ #define CFE_ES_START_INVALID_FILENAME_ERR_EID 27 @@ -381,7 +381,7 @@ #define CFE_ES_ERREXIT_APP_ERR_EID 33 /** - * \brief ES Stop Application Commmand Request Failed Event ID + * \brief ES Stop Application Command Request Failed Event ID * * \par Type: ERROR * @@ -1015,7 +1015,7 @@ * * The version information reported in this event is derived from the source revision * control system at build time, as opposed to manually-assigned semantic version numbers. - * It is intendended to uniquely identify the actual source code that is currently running, + * It is intended to uniquely identify the actual source code that is currently running, * to the extent this is possible. * * The \c Mission version information also identifies the build configuration name, if available. diff --git a/modules/es/fsw/inc/cfe_es_msg.h b/modules/es/fsw/inc/cfe_es_msg.h index 50c5aab76..8755f4d86 100644 --- a/modules/es/fsw/inc/cfe_es_msg.h +++ b/modules/es/fsw/inc/cfe_es_msg.h @@ -238,7 +238,7 @@ ** increment ** - The #CFE_ES_STOP_DBG_EID debug event message will be ** generated. NOTE: This event message only identifies that the -** stop request has been initiated, not that is has completed. +** stop request has been initiated, not that it has completed. ** - Once the stop has successfully completed, the list of Applications ** and Tasks created in response to the \b \c \ES_WRITEAPPINFO2FILE, ** \b \c \ES_WRITETASKINFO2FILE should no longer contain the @@ -291,7 +291,7 @@ ** increment ** - The #CFE_ES_RESTART_APP_DBG_EID debug event message will be ** generated. NOTE: This event message only identifies that the -** restart process has been initiated, not that is has completed. +** restart process has been initiated, not that it has completed. ** ** \par Error Conditions ** This command may fail for the following reason(s): @@ -315,7 +315,7 @@ */ #define CFE_ES_RESTART_APP_CC 6 -/** \cfeescmd Stops, Unloads, Loads from the command specfied File and Restarts an Application +/** \cfeescmd Stops, Unloads, Loads from the command specified File and Restarts an Application ** ** \par Description ** This command halts and removes the specified Application @@ -337,7 +337,7 @@ ** increment ** - The #CFE_ES_RELOAD_APP_DBG_EID debug event message will be ** generated. NOTE: This event message only identifies that the -** reload process has been initiated, not that is has completed. +** reload process has been initiated, not that it has completed. ** ** \par Error Conditions ** This command may fail for the following reason(s): @@ -417,7 +417,7 @@ ** generated. ** - The file specified in the command (or the default specified ** by the #CFE_PLATFORM_ES_DEFAULT_APP_LOG_FILE configuration parameter) will be -** updated with the lastest information. +** updated with the latest information. ** ** \par Error Conditions ** This command may fail for the following reason(s): @@ -494,7 +494,7 @@ ** generated. ** - The file specified in the command (or the default specified ** by the #CFE_PLATFORM_ES_DEFAULT_SYSLOG_FILE configuration parameter) will be -** updated with the lastest information. +** updated with the latest information. ** ** \par Error Conditions ** This command may fail for the following reason(s): @@ -517,7 +517,7 @@ */ #define CFE_ES_WRITE_SYSLOG_CC 11 -/** \cfeescmd Clears the contents of the Exeception and Reset Log +/** \cfeescmd Clears the contents of the Exception and Reset Log ** ** \par Description ** This command causes the contents of the Executive Services Exception @@ -551,7 +551,7 @@ */ #define CFE_ES_CLEAR_ER_LOG_CC 12 -/** \cfeescmd Writes Exeception and Reset Log to a File +/** \cfeescmd Writes Exception and Reset Log to a File ** ** \par Description ** This command causes the contents of the Executive Services Exception @@ -571,7 +571,7 @@ ** generated. ** - The file specified in the command (or the default specified ** by the #CFE_PLATFORM_ES_DEFAULT_ER_LOG_FILE configuration parameter) will be -** updated with the lastest information. +** updated with the latest information. ** ** \par Error Conditions ** This command may fail for the following reason(s): @@ -664,7 +664,7 @@ ** it has completed. ** - The file specified in the command (or the default specified ** by the #CFE_PLATFORM_ES_DEFAULT_PERF_DUMP_FILENAME configuration parameter) will be -** updated with the lastest information. +** updated with the latest information. ** ** \par Error Conditions ** This command may fail for the following reason(s): @@ -979,7 +979,7 @@ ** generated. ** - The file specified in the command (or the default specified ** by the #CFE_PLATFORM_ES_DEFAULT_CDS_REG_DUMP_FILE configuration parameter) will be -** updated with the lastest information. +** updated with the latest information. ** ** \par Error Conditions ** This command may fail for the following reason(s): @@ -1021,7 +1021,7 @@ ** generated. ** - The file specified in the command (or the default specified ** by the #CFE_PLATFORM_ES_DEFAULT_TASK_LOG_FILE configuration parameter) will be -** updated with the lastest information. +** updated with the latest information. ** ** \par Error Conditions ** This command may fail for the following reason(s): @@ -1524,7 +1524,7 @@ typedef struct CFE_ES_HousekeepingTlm_Payload uint32 PerfMode; /**< \cfetlmmnemonic \ES_PERFMODE \brief Current mode of Performance Analyzer */ uint32 PerfTriggerCount; /**< \cfetlmmnemonic \ES_PERFTRIGCNT - \brief Number of Times Perfomance Analyzer has Triggered */ + \brief Number of Times Performance Analyzer has Triggered */ uint32 PerfFilterMask[CFE_MISSION_ES_PERF_MAX_IDS / 32]; /**< \cfetlmmnemonic \ES_PERFFLTRMASK \brief Current Setting of Performance Analyzer Filter Masks */ uint32 diff --git a/modules/es/fsw/src/cfe_es_api.c b/modules/es/fsw/src/cfe_es_api.c index dd8c3094b..efd0c3281 100644 --- a/modules/es/fsw/src/cfe_es_api.c +++ b/modules/es/fsw/src/cfe_es_api.c @@ -540,7 +540,7 @@ bool CFE_ES_RunLoop(uint32 *RunStatus) /* * Check if the control request is also set to "RUN" - * Anything else should also return false, so the the loop will exit. + * Anything else should also return false, so the loop will exit. */ if (AppRecPtr->ControlReq.AppControlRequest == CFE_ES_RunStatus_APP_RUN) { @@ -1181,7 +1181,7 @@ int32 CFE_ES_GetModuleInfo(CFE_ES_AppInfo_t *ModuleInfo, CFE_ResourceId_t Resour { int32 Status; - /* Note - ModuleInfo NULL pointer check is perfromed by CFE_ES_GetAppInfo or CFE_ES_GetLibInfo */ + /* Note - ModuleInfo NULL pointer check is performed by CFE_ES_GetAppInfo or CFE_ES_GetLibInfo */ switch (CFE_ResourceId_GetBase(ResourceId)) { case CFE_ES_APPID_BASE: diff --git a/modules/es/fsw/src/cfe_es_apps.c b/modules/es/fsw/src/cfe_es_apps.c index 8db23681e..8d583fcb3 100644 --- a/modules/es/fsw/src/cfe_es_apps.c +++ b/modules/es/fsw/src/cfe_es_apps.c @@ -215,7 +215,7 @@ void CFE_ES_StartApplications(uint32 ResetType, const char *StartFilePath) if (NumTokens < CFE_ES_STARTSCRIPT_MAX_TOKENS_PER_LINE) { /* - * NOTE: pointer never deferenced unless "LineTooLong" is false. + * NOTE: pointer never dereferenced unless "LineTooLong" is false. */ TokenList[NumTokens] = &ES_AppLoadBuffer[BuffLen]; } @@ -1014,7 +1014,7 @@ bool CFE_ES_RunAppTableScan(uint32 ElapsedTime, void *Arg) /* * Every time a scan is initiated (for any reason) * reset the background scan timer to the full value, - * and take a snapshot of the the command counter. + * and take a snapshot of the command counter. */ NumAppTimeouts = 0; State->BackgroundScanTimer = CFE_PLATFORM_ES_APP_SCAN_RATE; diff --git a/modules/es/fsw/src/cfe_es_apps.h b/modules/es/fsw/src/cfe_es_apps.h index c8c80c9f7..62c2d9ec4 100644 --- a/modules/es/fsw/src/cfe_es_apps.h +++ b/modules/es/fsw/src/cfe_es_apps.h @@ -206,7 +206,7 @@ int32 CFE_ES_ParseFileEntry(const char **TokenList, uint32 NumTokens); * * Loads the module file via OSAL and stores all relevant info in the table entry as necessary. * - * This only loads the code and looks up relevent runtime information. + * This only loads the code and looks up relevant runtime information. * It does not start any tasks. */ int32 CFE_ES_LoadModule(CFE_ResourceId_t ParentResourceId, const char *ModuleName, @@ -277,7 +277,7 @@ bool CFE_ES_RunAppTableScan(uint32 ElapsedTime, void *Arg); * Scan for new exceptions stored in the PSP * * This function pools the PSP to check if any exceptions have been logged - * since the last background cycle. If an exception is present, retreive + * since the last background cycle. If an exception is present, retrieve * the details, add it to the ER log, and trigger the action (e.g. app restart). */ bool CFE_ES_RunExceptionScan(uint32 ElapsedTime, void *Arg); diff --git a/modules/es/fsw/src/cfe_es_cds_mempool.c b/modules/es/fsw/src/cfe_es_cds_mempool.c index e3c94f940..a2c1b5fd8 100644 --- a/modules/es/fsw/src/cfe_es_cds_mempool.c +++ b/modules/es/fsw/src/cfe_es_cds_mempool.c @@ -189,7 +189,7 @@ int32 CFE_ES_CDSBlockWrite(CFE_ES_CDSHandle_t Handle, const void *DataToWrite) size_t UserDataOffset; CFE_ES_CDS_RegRec_t * CDSRegRecPtr; - /* Ensure the the log message is an empty string in case it is never written to */ + /* Ensure the log message is an empty string in case it is never written to */ LogMessage[0] = 0; CDSRegRecPtr = CFE_ES_LocateCDSBlockRecordByID(Handle); diff --git a/modules/es/fsw/src/cfe_es_erlog.c b/modules/es/fsw/src/cfe_es_erlog.c index 93d3831be..3de73dc80 100644 --- a/modules/es/fsw/src/cfe_es_erlog.c +++ b/modules/es/fsw/src/cfe_es_erlog.c @@ -343,7 +343,7 @@ bool CFE_ES_RunExceptionScan(uint32 ElapsedTime, void *Arg) * The App ID was found, now see if the ExceptionAction is set for a reset * * NOTE: if anything in this logic fails and the app which caused the exception is not - * postively identified, then this will just follow the default case of PSP reset. + * positively identified, then this will just follow the default case of PSP reset. */ if (Status == CFE_SUCCESS) { diff --git a/modules/es/fsw/src/cfe_es_generic_pool.h b/modules/es/fsw/src/cfe_es_generic_pool.h index 10fc062dd..9cf10dec5 100644 --- a/modules/es/fsw/src/cfe_es_generic_pool.h +++ b/modules/es/fsw/src/cfe_es_generic_pool.h @@ -279,7 +279,7 @@ void CFE_ES_GenPoolGetBucketUsage(CFE_ES_GenPoolRecord_t *PoolRecPtr, uint16 Buc * * \note This is intended only as a sanity check on pool sizes, and does not * guarantee the ability to actually allocate buffers in a real pool. In particular, - * alignment is not factored into the this size calculation, and this may require + * alignment is not factored into the size calculation, and this may require * some additional overhead. * * \param[in] NumBlockSizes Number of entries in BlockSizeList diff --git a/modules/es/fsw/src/cfe_es_log.h b/modules/es/fsw/src/cfe_es_log.h index dbb4655b0..00a46f47c 100644 --- a/modules/es/fsw/src/cfe_es_log.h +++ b/modules/es/fsw/src/cfe_es_log.h @@ -254,7 +254,7 @@ int32 CFE_ES_SysLogSetMode(CFE_ES_LogMode_Enum_t Mode); * must be greater than (CFE_TIME_PRINTED_STRING_SIZE+2) to get a useful output. Any user-specified * output string will be truncated to fit into the remaining space. * - * \param Buffer User supplied buffer to output formatted sting into + * \param Buffer User supplied buffer to output formatted string into * \param BufferSize Size of "Buffer" parameter. Should be greater than (CFE_TIME_PRINTED_STRING_SIZE+2) * \param SpecStringPtr Printf-style format string * \param ArgPtr Variable argument list as obtained by va_start() in the caller diff --git a/modules/es/fsw/src/cfe_es_mempool.c b/modules/es/fsw/src/cfe_es_mempool.c index 46688c63c..8c8ac7184 100644 --- a/modules/es/fsw/src/cfe_es_mempool.c +++ b/modules/es/fsw/src/cfe_es_mempool.c @@ -332,7 +332,7 @@ CFE_Status_t CFE_ES_PoolCreateEx(CFE_ES_MemHandle_t *PoolID, void *MemPtr, size_ /* * Get the calling context. - * If this not a valid CFE context, then AppID will be undefined. + * If this is not a valid CFE context, then AppID will be undefined. * We can still permit the creation of the pool but automatic cleanup * if an exception or other event occurs will not be possible. */ diff --git a/modules/es/fsw/src/cfe_es_mempool.h b/modules/es/fsw/src/cfe_es_mempool.h index 3d2fbbc2e..4594ba8bc 100644 --- a/modules/es/fsw/src/cfe_es_mempool.h +++ b/modules/es/fsw/src/cfe_es_mempool.h @@ -82,7 +82,7 @@ typedef struct * * Index values are only guaranteed to be unique for resources of the same * type. For instance, the indices corresponding to two [valid] Memory Pool - * IDs will never overlap, but the index of an Memory Pool and a library ID + * IDs will never overlap, but the index of a Memory Pool and a library ID * may be the same. Furthermore, indices may be reused if a resource is * deleted and re-created. * @@ -200,7 +200,7 @@ static inline void CFE_ES_MemPoolRecordSetFree(CFE_ES_MemPoolRecord_t *PoolRecPt /*---------------------------------------------------------------------------------------*/ /** - * @brief Check if an Mem Pool record is a match for the given Pool ID + * @brief Check if a Mem Pool record is a match for the given Pool ID * * This routine confirms that the previously-located record is valid * and matches the expected Pool ID. diff --git a/modules/es/fsw/src/cfe_es_perf.h b/modules/es/fsw/src/cfe_es_perf.h index d3896f9fb..7f078a00a 100644 --- a/modules/es/fsw/src/cfe_es_perf.h +++ b/modules/es/fsw/src/cfe_es_perf.h @@ -109,7 +109,7 @@ typedef struct uint32 WorkCredit; /* accumulator based on the passage of time */ uint32 StateCounter; /* number of blocks/items left in current state */ uint32 DataPos; /* last position within the Perf Log */ - size_t FileSize; /* Total file size, for progress reporing in telemetry */ + size_t FileSize; /* Total file size, for progress reporting in telemetry */ } CFE_ES_PerfDumpGlobal_t; /* diff --git a/modules/es/fsw/src/cfe_es_resource.h b/modules/es/fsw/src/cfe_es_resource.h index 0530d3242..ec35beedd 100644 --- a/modules/es/fsw/src/cfe_es_resource.h +++ b/modules/es/fsw/src/cfe_es_resource.h @@ -398,7 +398,7 @@ static inline const char *CFE_ES_LibRecordGetName(const CFE_ES_LibRecord_t *LibR /*---------------------------------------------------------------------------------------*/ /** - * @brief Get the ID value from an Task table entry + * @brief Get the ID value from a Task table entry * * This routine converts the table entry back to an abstract ID. * @@ -438,7 +438,7 @@ static inline bool CFE_ES_TaskRecordIsUsed(const CFE_ES_TaskRecord_t *TaskRecPtr /*---------------------------------------------------------------------------------------*/ /** - * @brief Marks an Task table entry as used (not free) + * @brief Marks a Task table entry as used (not free) * * This sets the internal field(s) within this entry, and marks * it as being associated with the given Task ID. @@ -525,7 +525,7 @@ static inline const char *CFE_ES_TaskRecordGetName(const CFE_ES_TaskRecord_t *Ta /*---------------------------------------------------------------------------------------*/ /** - * @brief Check if an Counter record is in use or free/empty + * @brief Check if a Counter record is in use or free/empty * * This routine checks if the Counter table entry is in use or if it is free * @@ -545,7 +545,7 @@ static inline bool CFE_ES_CounterRecordIsUsed(const CFE_ES_GenCounterRecord_t *C /*---------------------------------------------------------------------------------------*/ /** - * @brief Get the ID value from an Counter table entry + * @brief Get the ID value from a Counter table entry * * This routine converts the table entry back to an abstract ID. * @@ -562,7 +562,7 @@ static inline CFE_ES_CounterId_t CFE_ES_CounterRecordGetID(const CFE_ES_GenCount /*---------------------------------------------------------------------------------------*/ /** - * @brief Marks an Counter table entry as used (not free) + * @brief Marks a Counter table entry as used (not free) * * This sets the internal field(s) within this entry, and marks * it as being associated with the given Counter ID. @@ -583,7 +583,7 @@ static inline void CFE_ES_CounterRecordSetUsed(CFE_ES_GenCounterRecord_t *Counte /*---------------------------------------------------------------------------------------*/ /** - * @brief Set an Counter record table entry free (not used) + * @brief Set a Counter record table entry free (not used) * * This clears the internal field(s) within this entry, and allows the * memory to be re-used in the future. @@ -603,7 +603,7 @@ static inline void CFE_ES_CounterRecordSetFree(CFE_ES_GenCounterRecord_t *Counte /*---------------------------------------------------------------------------------------*/ /** - * @brief Check if an Counter record is a match for the given CounterID + * @brief Check if a Counter record is a match for the given CounterID * * This routine confirms that the previously-located record is valid * and matches the expected Counter ID. diff --git a/modules/es/fsw/src/cfe_es_syslog.c b/modules/es/fsw/src/cfe_es_syslog.c index fd2a7efce..d03f96281 100644 --- a/modules/es/fsw/src/cfe_es_syslog.c +++ b/modules/es/fsw/src/cfe_es_syslog.c @@ -228,7 +228,7 @@ int32 CFE_ES_SysLogAppend_Unsync(const char *LogString) WriteIdx += MessageLen; /* - * Ensure the that last-written character is a newline. + * Ensure that the last-written character is a newline. * This would have been enforced already except in cases where * the message got truncated. */ diff --git a/modules/es/fsw/src/cfe_es_task.c b/modules/es/fsw/src/cfe_es_task.c index fbc74dcde..31b532f38 100644 --- a/modules/es/fsw/src/cfe_es_task.c +++ b/modules/es/fsw/src/cfe_es_task.c @@ -505,7 +505,7 @@ int32 CFE_ES_TaskInit(void) /* * Initialize the "background task" which is a low priority child task - * devoted to maintence duties that do not need to execute on a + * devoted to maintenance duties that do not need to execute on a * strict/precise schedule. */ Status = CFE_ES_BackgroundInit(); diff --git a/modules/es/fsw/src/cfe_es_task.h b/modules/es/fsw/src/cfe_es_task.h index 4b17c54ed..c5e281cd7 100644 --- a/modules/es/fsw/src/cfe_es_task.h +++ b/modules/es/fsw/src/cfe_es_task.h @@ -280,7 +280,7 @@ int32 CFE_ES_DumpCDSRegistryCmd(const CFE_ES_DumpCDSRegistryCmd_t *data); /*---------------------------------------------------------------------------------------*/ /** - * \brief Insures that the handle passed in meets all of the requirements of a valid handle. + * \brief Ensures that the handle passed in meets all of the requirements of a valid handle. */ bool CFE_ES_ValidateHandle(CFE_ES_MemHandle_t Handle); diff --git a/modules/es/ut-coverage/es_UT.c b/modules/es/ut-coverage/es_UT.c index cf315f6d5..1ee99016a 100644 --- a/modules/es/ut-coverage/es_UT.c +++ b/modules/es/ut-coverage/es_UT.c @@ -626,7 +626,7 @@ void ES_ResetUnitTest(void) * This was formerly a separate global, but now part of CFE_ES_Global. * * Some unit tests assume/rely on it preserving its value across tests, - * so is must be re-initialized here every time CFE_ES_Global is reset. + * so it must be re-initialized here every time CFE_ES_Global is reset. */ CFE_ES_Global.ResetDataPtr = ES_UT_PersistentResetData; @@ -697,7 +697,7 @@ void TestStartupErrorPaths(void) UtAssert_STUB_COUNT(CFE_PSP_Panic, 1); UtAssert_UINT32_EQ(PanicStatus, CFE_PSP_PANIC_STARTUP_SEM); - /* Perform ES main startup with a ES Perf Data mutex creation failure */ + /* Perform ES main startup with an ES Perf Data mutex creation failure */ ES_ResetUnitTest(); UT_SetDeferredRetcode(UT_KEY(OS_MutSemCreate), 2, OS_ERROR); UT_SetDataBuffer(UT_KEY(CFE_PSP_Panic), &PanicStatus, sizeof(PanicStatus), false); @@ -705,7 +705,7 @@ void TestStartupErrorPaths(void) UtAssert_UINT32_EQ(PanicStatus, CFE_PSP_PANIC_STARTUP_SEM); UtAssert_UINT32_EQ(UT_GetStubCount(UT_KEY(CFE_PSP_Panic)), 1); - /* Perform ES main startup with a ES Shared Data mutex creation failure */ + /* Perform ES main startup with an ES Shared Data mutex creation failure */ ES_ResetUnitTest(); UT_SetDummyFuncRtn(OS_SUCCESS); UT_SetDefaultReturnValue(UT_KEY(OS_OpenCreate), OS_ERROR); @@ -765,7 +765,7 @@ void TestStartupErrorPaths(void) CFE_ES_SetupResetVariables(CFE_PSP_RST_TYPE_PROCESSOR, CFE_PSP_RST_SUBTYPE_HW_SPECIAL_COMMAND, 1); CFE_UtAssert_PRINTF(UT_OSP_MESSAGES[UT_OSP_POR_MAX_HW_SPECIAL]); - /* Perform a processor reset with an reset area failure */ + /* Perform a processor reset with a reset area failure */ ES_ResetUnitTest(); UT_SetStatusBSPResetArea(OS_ERROR, 0, CFE_TIME_ToneSignalSelect_PRIMARY); UT_SetDataBuffer(UT_KEY(CFE_PSP_Panic), &PanicStatus, sizeof(PanicStatus), false); @@ -1801,7 +1801,7 @@ void TestLibs(void) CFE_UtAssert_SUCCESS(CFE_ES_LoadLibrary(&Id, "TST_LIB1", &LoadParams)); UtAssert_STUB_COUNT(OS_ModuleSymbolLookup, 0); /* should NOT have been called */ - /* Likewise for a entry point where the string is empty */ + /* Likewise for an entry point where the string is empty */ LoadParams.InitSymbolName[0] = 0; CFE_UtAssert_SUCCESS(CFE_ES_LoadLibrary(&Id, "TST_LIB2", &LoadParams)); UtAssert_STUB_COUNT(OS_ModuleSymbolLookup, 0); /* should NOT have been called */ @@ -2007,7 +2007,7 @@ void TestGenericPool(void) UtAssert_UINT32_EQ(CountBuf, 3); UtAssert_NONZERO(FreeSize); - /* put blocks so the pool has a mixture of allocated an deallocated blocks */ + /* put blocks so the pool has a mixture of allocated and deallocated blocks */ CFE_UtAssert_SUCCESS(CFE_ES_GenPoolPutBlock(&Pool1, &BlockSize, Offset1)); CFE_UtAssert_SUCCESS(CFE_ES_GenPoolPutBlock(&Pool1, &BlockSize, Offset2)); @@ -3394,7 +3394,7 @@ void TestPerf(void) UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, 0, UT_TPID_CFE_ES_CMD_STOP_PERF_DATA_CC); CFE_UtAssert_EVENTNOTSENT(CFE_ES_PERF_STOPCMD_EID); - /* Test performance data filer mask with an invalid message length */ + /* Test performance data filter mask with an invalid message length */ ES_ResetUnitTest(); UT_CallTaskPipe(CFE_ES_TaskPipe, &CmdBuf.Msg, 0, UT_TPID_CFE_ES_CMD_SET_PERF_FILTER_MASK_CC); CFE_UtAssert_EVENTNOTSENT(CFE_ES_PERF_FILTMSKCMD_EID); diff --git a/modules/es/ut-coverage/es_UT.h b/modules/es/ut-coverage/es_UT.h index f91b9e398..ac6fcd4bc 100644 --- a/modules/es/ut-coverage/es_UT.h +++ b/modules/es/ut-coverage/es_UT.h @@ -83,7 +83,7 @@ void TestInit(void); ** \par Description ** This function exercises the remaining (error condition) paths for the ** ES main startup that were not covered in TestInit. The remaining -** functions in cfe_es_start.c for initializing the the ES reset +** functions in cfe_es_start.c for initializing the ES reset ** variables, the file system, and the application layer are then ** tested. ** diff --git a/modules/evs/fsw/inc/cfe_evs_events.h b/modules/evs/fsw/inc/cfe_evs_events.h index 753260131..0cd8d3dd5 100644 --- a/modules/evs/fsw/inc/cfe_evs_events.h +++ b/modules/evs/fsw/inc/cfe_evs_events.h @@ -118,7 +118,7 @@ * * \par Cause: * - * An EVS command handler failure retreiving the application data. OVERLOADED + * An EVS command handler failure retrieving the application data. OVERLOADED */ #define CFE_EVS_ERR_ILLAPPIDRANGE_EID 8 @@ -129,7 +129,7 @@ * * \par Cause: * - * An EVS command handler failure retreiving the application ID. OVERLOADED + * An EVS command handler failure retrieving the application ID. OVERLOADED */ #define CFE_EVS_ERR_NOAPPIDFOUND_EID 9 diff --git a/modules/evs/fsw/inc/cfe_evs_msg.h b/modules/evs/fsw/inc/cfe_evs_msg.h index 949c6869b..84a8de8ac 100644 --- a/modules/evs/fsw/inc/cfe_evs_msg.h +++ b/modules/evs/fsw/inc/cfe_evs_msg.h @@ -761,7 +761,7 @@ ** - The generation of #CFE_EVS_WRDAT_EID debug event message ** - The file specified in the command (or the default specified ** by the #CFE_PLATFORM_EVS_DEFAULT_APP_DATA_FILE configuration parameter) will be -** updated with the lastest information. +** updated with the latest information. ** ** \par Error Conditions ** This command may fail for the following reason(s): @@ -946,7 +946,7 @@ typedef struct CFE_EVS_WriteLogDataFileCmd **/ typedef struct CFE_EVS_AppDataCmd_Payload { - char AppDataFilename[CFE_MISSION_MAX_PATH_LEN]; /**< \brief Filename where applicaton data is to be written */ + char AppDataFilename[CFE_MISSION_MAX_PATH_LEN]; /**< \brief Filename where application data is to be written */ } CFE_EVS_AppDataCmd_Payload_t; /** diff --git a/modules/evs/fsw/src/cfe_evs_task.c b/modules/evs/fsw/src/cfe_evs_task.c index df4727d3e..cd19e038f 100644 --- a/modules/evs/fsw/src/cfe_evs_task.c +++ b/modules/evs/fsw/src/cfe_evs_task.c @@ -724,7 +724,7 @@ int32 CFE_EVS_SetFilterCmd(const CFE_EVS_SetFilterCmd_t *data) /* Copy appname from command, ensures NULL termination */ CFE_SB_MessageStringGet(LocalName, (char *)CmdPtr->AppName, NULL, sizeof(LocalName), sizeof(CmdPtr->AppName)); - /* Retreive application data */ + /* Retrieve application data */ Status = EVS_GetApplicationInfo(&AppDataPtr, LocalName); if (Status == CFE_SUCCESS) @@ -1079,7 +1079,7 @@ int32 CFE_EVS_DisableAppEventTypeCmd(const CFE_EVS_DisableAppEventTypeCmd_t *dat /* Copy appname from command, ensures NULL termination */ CFE_SB_MessageStringGet(LocalName, (char *)CmdPtr->AppName, NULL, sizeof(LocalName), sizeof(CmdPtr->AppName)); - /* Retreive application data */ + /* Retrieve application data */ Status = EVS_GetApplicationInfo(&AppDataPtr, LocalName); if (Status == CFE_SUCCESS) @@ -1193,7 +1193,7 @@ int32 CFE_EVS_DisableAppEventsCmd(const CFE_EVS_DisableAppEventsCmd_t *data) /* Copy appname from command, ensures NULL termination */ CFE_SB_MessageStringGet(LocalName, (char *)CmdPtr->AppName, NULL, sizeof(LocalName), sizeof(CmdPtr->AppName)); - /* Retreive application data */ + /* Retrieve application data */ Status = EVS_GetApplicationInfo(&AppDataPtr, LocalName); if (Status == CFE_SUCCESS) @@ -1242,7 +1242,7 @@ int32 CFE_EVS_ResetAppCounterCmd(const CFE_EVS_ResetAppCounterCmd_t *data) /* Copy appname from command, ensures NULL termination */ CFE_SB_MessageStringGet(LocalName, (char *)CmdPtr->AppName, NULL, sizeof(LocalName), sizeof(CmdPtr->AppName)); - /* Retreive application data */ + /* Retrieve application data */ Status = EVS_GetApplicationInfo(&AppDataPtr, LocalName); if (Status == CFE_SUCCESS) @@ -1292,7 +1292,7 @@ int32 CFE_EVS_ResetFilterCmd(const CFE_EVS_ResetFilterCmd_t *data) /* Copy appname from command, ensures NULL termination */ CFE_SB_MessageStringGet(LocalName, (char *)CmdPtr->AppName, NULL, sizeof(LocalName), sizeof(CmdPtr->AppName)); - /* Retreive application data */ + /* Retrieve application data */ Status = EVS_GetApplicationInfo(&AppDataPtr, LocalName); if (Status == CFE_SUCCESS) @@ -1356,7 +1356,7 @@ int32 CFE_EVS_ResetAllFiltersCmd(const CFE_EVS_ResetAllFiltersCmd_t *data) /* Copy appname from command, ensures NULL termination */ CFE_SB_MessageStringGet(LocalName, (char *)CmdPtr->AppName, NULL, sizeof(LocalName), sizeof(CmdPtr->AppName)); - /* Retreive application data */ + /* Retrieve application data */ Status = EVS_GetApplicationInfo(&AppDataPtr, LocalName); if (Status == CFE_SUCCESS) @@ -1409,7 +1409,7 @@ int32 CFE_EVS_AddEventFilterCmd(const CFE_EVS_AddEventFilterCmd_t *data) /* Copy appname from command, ensures NULL termination */ CFE_SB_MessageStringGet(LocalName, (char *)CmdPtr->AppName, NULL, sizeof(LocalName), sizeof(CmdPtr->AppName)); - /* Retreive application data */ + /* Retrieve application data */ Status = EVS_GetApplicationInfo(&AppDataPtr, LocalName); if (Status == CFE_SUCCESS) @@ -1493,7 +1493,7 @@ int32 CFE_EVS_DeleteEventFilterCmd(const CFE_EVS_DeleteEventFilterCmd_t *data) /* Copy appname from command, ensures NULL termination */ CFE_SB_MessageStringGet(LocalName, (char *)CmdPtr->AppName, NULL, sizeof(LocalName), sizeof(CmdPtr->AppName)); - /* Retreive application data */ + /* Retrieve application data */ Status = EVS_GetApplicationInfo(&AppDataPtr, LocalName); if (Status == CFE_SUCCESS) diff --git a/modules/evs/fsw/src/cfe_evs_task.h b/modules/evs/fsw/src/cfe_evs_task.h index 6dcd8bf5d..ed750014c 100644 --- a/modules/evs/fsw/src/cfe_evs_task.h +++ b/modules/evs/fsw/src/cfe_evs_task.h @@ -306,7 +306,7 @@ int32 CFE_EVS_AddEventFilterCmd(const CFE_EVS_AddEventFilterCmd_t *data); * @brief Message Handler Function * * This routine deletes the event filter for the given application - * identifer and event identifier + * identifier and event identifier */ int32 CFE_EVS_DeleteEventFilterCmd(const CFE_EVS_DeleteEventFilterCmd_t *data); diff --git a/modules/evs/ut-coverage/evs_UT.c b/modules/evs/ut-coverage/evs_UT.c index d3a476d5d..bb205f606 100644 --- a/modules/evs/ut-coverage/evs_UT.c +++ b/modules/evs/ut-coverage/evs_UT.c @@ -301,7 +301,7 @@ void Test_Init(void) CFE_EVS_EarlyInit(); CFE_UtAssert_SYSLOG(EVS_SYSLOG_MSGS[2]); - /* Repeat sucessful initialization to configure log for later references */ + /* Repeat successful initialization to configure log for later references */ UT_InitData(); UT_SetSizeofESResetArea(sizeof(CFE_ES_ResetData_t)); UT_SetDeferredRetcode(UT_KEY(OS_MutSemCreate), 1, OS_SUCCESS); @@ -1626,7 +1626,7 @@ void Test_FilterCmd(void) &UT_EVS_EventBuf); UtAssert_UINT32_EQ(UT_EVS_EventBuf.EventID, CFE_EVS_EVT_FILTERED_EID); - /* Test successful event filer deletion */ + /* Test successful event filter deletion */ UT_InitData(); UT_EVS_DoDispatchCheckEvents(&appcmdcmd, sizeof(appcmdcmd), UT_TPID_CFE_EVS_CMD_DELETE_EVENT_FILTER_CC, &UT_EVS_EventBuf); diff --git a/modules/fs/ut-coverage/fs_UT.c b/modules/fs/ut-coverage/fs_UT.c index b670d1bcc..5c4ffa6fc 100644 --- a/modules/fs/ut-coverage/fs_UT.c +++ b/modules/fs/ut-coverage/fs_UT.c @@ -174,7 +174,7 @@ void Test_CFE_FS_SetTimestamp(void) UT_SetDefaultReturnValue(UT_KEY(OS_write), OS_ERROR); UtAssert_INT32_EQ(CFE_FS_SetTimestamp(FileDes, NewTimestamp), CFE_STATUS_EXTERNAL_RESOURCE_FAIL); - /* Test setting the time stamp with a subeconds write failure */ + /* Test setting the time stamp with a subseconds write failure */ UT_InitData(); UT_SetDeferredRetcode(UT_KEY(OS_write), 1, 0); UtAssert_INT32_EQ(CFE_FS_SetTimestamp(FileDes, NewTimestamp), CFE_STATUS_EXTERNAL_RESOURCE_FAIL); @@ -625,7 +625,7 @@ void Test_CFE_FS_BackgroundFileDump(void) UT_ResetState(UT_KEY(UT_FS_DataGetter)); - /* Request multiple file dumps, check queing logic */ + /* Request multiple file dumps, check queuing logic */ CFE_UtAssert_SETUP(CFE_FS_BackgroundFileDumpRequest(&State)); UtAssert_INT32_EQ(CFE_FS_BackgroundFileDumpRequest(&State), CFE_STATUS_REQUEST_ALREADY_PENDING); diff --git a/modules/msg/fsw/inc/ccsds_hdr.h b/modules/msg/fsw/inc/ccsds_hdr.h index 9aaaa3b01..1dd8c4252 100644 --- a/modules/msg/fsw/inc/ccsds_hdr.h +++ b/modules/msg/fsw/inc/ccsds_hdr.h @@ -43,7 +43,7 @@ * Structure definitions for CCSDS headers. * * CCSDS headers must always be in network byte order per the standard. - * MSB at the lowest address which is commonly refered to as "BIG Endian" + * MSB at the lowest address which is commonly referred to as "BIG Endian" * */ diff --git a/modules/resourceid/option_inc/cfe_resourceid_simple.h b/modules/resourceid/option_inc/cfe_resourceid_simple.h index fe6348d3a..5f4795483 100644 --- a/modules/resourceid/option_inc/cfe_resourceid_simple.h +++ b/modules/resourceid/option_inc/cfe_resourceid_simple.h @@ -51,14 +51,14 @@ typedef uint32 CFE_ResourceId_t; * * In simple mode this is zero/disabled so that OSAL IDs and CFE IDs will * have the same underlying values. This replicates historical behavior where - * CFE Task IDs and OSAL task IDs are same thing and are interchangable. + * CFE Task IDs and OSAL task IDs are same thing and are interchangeable. */ #define CFE_RESOURCEID_MARK 0 /* * Wrap/Unwrap macros. * - * In simple mode theese are a pass through/no-op as values are not + * In simple mode these are a pass through/no-op as values are not * wrapped/protected. */ #define CFE_RESOURCEID_WRAP(x) x diff --git a/modules/resourceid/option_inc/cfe_resourceid_strict.h b/modules/resourceid/option_inc/cfe_resourceid_strict.h index f71c30727..8005079ca 100644 --- a/modules/resourceid/option_inc/cfe_resourceid_strict.h +++ b/modules/resourceid/option_inc/cfe_resourceid_strict.h @@ -71,7 +71,7 @@ typedef struct * @brief A fixed bit that should be set in all CFE resource ID values * * In strict mode this is nonzero so that OSAL IDs and CFE IDs will have - * different values. This means that CFE Task IDs will not be interchangable + * different values. This means that CFE Task IDs will not be interchangeable * with OSAL task IDs, either in value or type. */ #define CFE_RESOURCEID_MARK 0x02000000 diff --git a/modules/sb/fsw/inc/cfe_sb_events.h b/modules/sb/fsw/inc/cfe_sb_events.h index f175ead5d..4591b6d3a 100644 --- a/modules/sb/fsw/inc/cfe_sb_events.h +++ b/modules/sb/fsw/inc/cfe_sb_events.h @@ -174,7 +174,7 @@ * * \par Cause: * - * An SB Transmit API failed due to an invalid imput argument. + * An SB Transmit API failed due to an invalid input argument. */ #define CFE_SB_SEND_BAD_ARG_EID 13 @@ -241,7 +241,7 @@ * * \par Cause: * - * #CFE_SB_ReceiveBuffer API falure due to an invalid Pipe ID. + * #CFE_SB_ReceiveBuffer API failure due to an invalid Pipe ID. */ #define CFE_SB_BAD_PIPEID_EID 19 @@ -691,7 +691,7 @@ * * \par Cause: * - * #CFE_SB_GetPipeName failure due to invalid pipe ID or failure in retreiving resource name. OVERLOADED + * #CFE_SB_GetPipeName failure due to invalid pipe ID or failure in retrieving resource name. OVERLOADED */ #define CFE_SB_GETPIPENAME_ID_ERR_EID 64 @@ -724,7 +724,7 @@ * * \par Cause: * - * #CFE_SB_GetPipeIdByName faiure due to name not found or ID mismatch. OVERLOADED + * #CFE_SB_GetPipeIdByName failure due to name not found or ID mismatch. OVERLOADED */ #define CFE_SB_GETPIPEIDBYNAME_NAME_ERR_EID 67 diff --git a/modules/sb/fsw/inc/cfe_sb_msg.h b/modules/sb/fsw/inc/cfe_sb_msg.h index ecf415951..eb505f81d 100644 --- a/modules/sb/fsw/inc/cfe_sb_msg.h +++ b/modules/sb/fsw/inc/cfe_sb_msg.h @@ -164,7 +164,7 @@ ** This command will create a file containing the software bus routing ** information. The routing information contains information about every ** subscription that has been received through the SB subscription APIs. -** An abosulte path and filename may be specified in the command. +** An absolute path and filename may be specified in the command. ** If this command field contains an empty string (NULL terminator as ** the first character) the default file path and name is used. ** The default file path and name is defined in the platform @@ -183,7 +183,7 @@ ** before writing the file, which is performed as a background task. ** - The file specified in the command (or the default specified ** by the #CFE_PLATFORM_SB_DEFAULT_ROUTING_FILENAME configuration parameter) will be -** updated with the lastest information. +** updated with the latest information. ** - The #CFE_SB_SND_RTG_EID debug event message will be generated ** ** \par Error Conditions @@ -208,7 +208,7 @@ ** \par Description ** This command will enable a particular destination. The destination ** is specified in terms of MsgID and PipeID. The MsgId and PipeID are -** parmaters in the command. All destinations are enabled by default. +** parameters in the command. All destinations are enabled by default. ** This command is needed only after a #CFE_SB_DISABLE_ROUTE_CC command ** is used. ** @@ -228,7 +228,7 @@ ** ** \par Error Conditions ** This command may fail for the following reason(s): -** - the MsgId or PipeId parmaters do not pass validation +** - the MsgId or PipeId parameters do not pass validation ** - the destination does not exist. ** ** Evidence of failure may be found in the following telemetry: @@ -246,7 +246,7 @@ ** \par Description ** This command will disable a particular destination. The destination ** is specified in terms of MsgID and PipeID. The MsgId and PipeID are -** parmaters in the command. All destinations are enabled by default. +** parameters in the command. All destinations are enabled by default. ** ** \cfecmdmnemonic \SB_DISROUTE ** @@ -264,7 +264,7 @@ ** ** \par Error Conditions ** This command may fail for the following reason(s): -** - the MsgId or PipeId parmaters do not pass validation +** - the MsgId or PipeId parameters do not pass validation ** - the destination does not exist. ** ** Evidence of failure may be found in the following telemetry: @@ -275,7 +275,7 @@ ** \par Criticality ** This command is not intended to be used in nominal conditions. It is ** possible to get into a state where a destination cannot be re-enabled -** without reseting the processor. For instance, sending this command +** without resetting the processor. For instance, sending this command ** with #CFE_SB_CMD_MID and the SB_Cmd_Pipe would inhibit any ground ** commanding to the software bus until the processor was reset. There ** are similar problems that may occur when using this command. @@ -288,7 +288,7 @@ ** This command will create a file containing the software bus pipe ** information. The pipe information contains information about every ** pipe that has been created through the #CFE_SB_CreatePipe API. An -** abosulte path and filename may be specified in the command. +** absolute path and filename may be specified in the command. ** If this command field contains an empty string (NULL terminator as ** the first character) the default file path and name is used. ** The default file path and name is defined in the platform @@ -307,7 +307,7 @@ ** before writing the file, which is performed as a background task. ** - The file specified in the command (or the default specified ** by the #CFE_PLATFORM_SB_DEFAULT_PIPE_FILENAME configuration parameter) will be -** updated with the lastest information. +** updated with the latest information. ** - The #CFE_SB_SND_RTG_EID debug event message will be generated ** ** \par Error Conditions @@ -332,9 +332,9 @@ ** \par This command will create a file containing the software bus message ** map information. The message map is a lookup table (an array of ** uint16s)that allows fast access to the correct routing table element -** during a softeware bus send operation. This is diasgnostic +** during a software bus send operation. This is diagnostic ** information that may be needed due to the dynamic nature of the -** cFE software bus. An abosulte path and filename may be specified +** cFE software bus. An absolute path and filename may be specified ** in the command. If this command field contains an empty string ** (NULL terminator as the first character) the default file path and ** name is used. The default file path and name is defined in the @@ -353,7 +353,7 @@ ** before writing the file, which is performed as a background task. ** - The file specified in the command (or the default specified ** by the #CFE_PLATFORM_SB_DEFAULT_MAP_FILENAME configuration parameter) will be -** updated with the lastest information. +** updated with the latest information. ** - The #CFE_SB_SND_RTG_EID debug event message will be generated ** ** \par Error Conditions @@ -383,7 +383,7 @@ ** and send a software bus packet for each subscription received. ** The software bus packet that is sent contains the information ** received in the subscription API. This subscription report is -** neeeded by SBN if offboard routing is required. +** needed by SBN if offboard routing is required. * ** \cfecmdmnemonic \SB_ENASUBRPTG ** @@ -416,7 +416,7 @@ ** and send a software bus packet for each subscription received. ** The software bus packet that is sent contains the information ** received in the subscription API. This subscription report is -** neeeded by SBN if offboard routing is required. +** needed by SBN if offboard routing is required. ** ** \cfecmdmnemonic \SB_DISSUBRPTG ** @@ -479,7 +479,7 @@ * SB Messages which have no payload are each * given unique typedefs to follow the command handler convention * - * For the SB application these is mapped to the CFE_MSG_CommandHeader_t type, + * For the SB application these are mapped to the CFE_MSG_CommandHeader_t type, * as they contain only a primary + command header. */ typedef CFE_MSG_CommandHeader_t CFE_SB_NoopCmd_t; diff --git a/modules/sb/fsw/src/cfe_sb_api.c b/modules/sb/fsw/src/cfe_sb_api.c index 531489ab3..b3a24a701 100644 --- a/modules/sb/fsw/src/cfe_sb_api.c +++ b/modules/sb/fsw/src/cfe_sb_api.c @@ -29,7 +29,7 @@ ** StreamId - First 16 bits of CCSDS Space Packet Protocol (SPP) 133.0-B.1c2 Blue Book ** packet primary header. It contains the 3 bit Version Number, 1 bit Packet Type ID, ** 1 bit Secondary Header flag, and 11 bit Application Process ID -** It was used in earlier cFS implementaions and is defined here for historical reference +** It was used in earlier cFS implementations and is defined here for historical reference ** It is NOT exposed to user applications. ** ** MsgId - Unique numeric message identifier within a mission namespace. It is used by cFS @@ -1380,7 +1380,7 @@ CFE_Status_t CFE_SB_TransmitMsg(const CFE_MSG_Message_t *MsgPtr, bool IncrementS * but there will be no buffer because CFE_SBR_IsValidRouteId() returned * false. * - * But if the desciptor is non-null it means the message is valid and + * But if the descriptor is non-null it means the message is valid and * there is a route to send it to. */ if (BufDscPtr != NULL) @@ -1395,7 +1395,7 @@ CFE_Status_t CFE_SB_TransmitMsg(const CFE_MSG_Message_t *MsgPtr, bool IncrementS /* * This routine will use best-effort to send to all subscribers, * increment the buffer use count for every successful delivery, - * and send an event/increment counter for any unsucessful delivery. + * and send an event/increment counter for any unsuccessful delivery. */ CFE_SB_BroadcastBufferToRoute(BufDscPtr, RouteId); @@ -1574,7 +1574,7 @@ void CFE_SB_BroadcastBufferToRoute(CFE_SB_BufferD_t *BufDscPtr, CFE_SBR_RouteId_ /* take semaphore to prevent a task switch during processing */ CFE_SB_LockSharedData(__func__, __LINE__); - /* For an invalid route / no subsribers this whole logic can be skipped */ + /* For an invalid route / no subscribers this whole logic can be skipped */ if (CFE_SBR_IsValidRouteId(RouteId)) { /* Set the seq count if requested (while locked) before actually sending */ @@ -1665,7 +1665,7 @@ void CFE_SB_BroadcastBufferToRoute(CFE_SB_BufferD_t *BufDscPtr, CFE_SBR_RouteId_ } /* - * If any specific delivery issues occured, also increment the + * If any specific delivery issues occurred, also increment the * general error count before releasing the lock. */ if (SBSndErr.EvtsToSnd > 0) @@ -1832,7 +1832,7 @@ CFE_Status_t CFE_SB_ReceiveBuffer(CFE_SB_Buffer_t **BufPtr, CFE_SB_PipeId_t Pipe Status = CFE_SB_BAD_ARGUMENT; } - /* If OK, then lock and pull relevent info from Pipe Descriptor */ + /* If OK, then lock and pull relevant info from Pipe Descriptor */ if (Status == CFE_SUCCESS) { CFE_SB_LockSharedData(__func__, __LINE__); diff --git a/modules/sb/fsw/src/cfe_sb_buf.c b/modules/sb/fsw/src/cfe_sb_buf.c index a90284c13..578b7640f 100644 --- a/modules/sb/fsw/src/cfe_sb_buf.c +++ b/modules/sb/fsw/src/cfe_sb_buf.c @@ -256,7 +256,7 @@ int32 CFE_SB_PutDestinationBlk(CFE_SB_DestinationD_t *Dest) Stat = CFE_ES_PutPoolBuf(CFE_SB_Global.Mem.PoolHdl, Dest); if (Stat > 0) { - /* Substract the size of the destination block from the Memory in use ctr */ + /* Subtract the size of the destination block from the Memory in use ctr */ CFE_SB_Global.StatTlmMsg.Payload.MemInUse -= Stat; } /* end if */ diff --git a/modules/sb/fsw/src/cfe_sb_init.c b/modules/sb/fsw/src/cfe_sb_init.c index 4cdc016a6..1daa95834 100644 --- a/modules/sb/fsw/src/cfe_sb_init.c +++ b/modules/sb/fsw/src/cfe_sb_init.c @@ -71,7 +71,7 @@ int32 CFE_SB_EarlyInit(void) return CFE_STATUS_EXTERNAL_RESOURCE_FAIL; } /* end if */ - /* Initialize the state of susbcription reporting */ + /* Initialize the state of subscription reporting */ CFE_SB_Global.SubscriptionReporting = CFE_SB_DISABLE; /* Initialize memory partition. */ diff --git a/modules/sb/fsw/src/cfe_sb_priv.c b/modules/sb/fsw/src/cfe_sb_priv.c index b5b0e7c74..350ef643c 100644 --- a/modules/sb/fsw/src/cfe_sb_priv.c +++ b/modules/sb/fsw/src/cfe_sb_priv.c @@ -34,7 +34,7 @@ ** StreamId - First 16 bits of CCSDS Space Packet Protocol (SPP) 133.0-B.1c2 Blue Book ** packet primary header. It contains the 3 bit Version Number, 1 bit Packet Type ID, ** 1 bit Secondary Header flag, and 11 bit Application Process ID -** It was used in earlier cFS implementaions and is defined here for historical reference +** It was used in earlier cFS implementations and is defined here for historical reference ** It is NOT exposed to user applications. ** ** MsgId - Unique numeric message identifier within a mission namespace. It is used by cFS diff --git a/modules/sb/fsw/src/cfe_sb_priv.h b/modules/sb/fsw/src/cfe_sb_priv.h index d4a5c90e5..54df50a38 100644 --- a/modules/sb/fsw/src/cfe_sb_priv.h +++ b/modules/sb/fsw/src/cfe_sb_priv.h @@ -140,9 +140,9 @@ typedef struct CFE_SB_BufferD * Current owner of the buffer, if owned by a single app. * * This is used to track "zero copy" buffer allocations - this will be set to - * the AppID that initally allocated it, before it is used to transmit a message. + * the AppID that initially allocated it, before it is used to transmit a message. * - * When the message is in transit, it may be queued to multiple applictions, + * When the message is in transit, it may be queued to multiple applications, * so this is unset. */ CFE_ES_AppId_t AppId; @@ -199,8 +199,8 @@ typedef struct /** ** \brief SB route info temporary structure ** -** This tracks the number of desinations along with destination data for 1 route. -** Each route may contain zero or more desinations (variable length). +** This tracks the number of destinations along with destination data for 1 route. +** Each route may contain zero or more destinations (variable length). */ typedef struct { @@ -473,7 +473,7 @@ void CFE_SB_IncrBufUseCnt(CFE_SB_BufferD_t *bd); * UseCount is a variable in the CFE_SB_BufferD_t and is used to * determine when a buffer may be returned to the memory pool. * - * If the the UseCount is decremented to zero, it will return the buffer to + * If the UseCount is decremented to zero, it will return the buffer to * the memory pool. * * @note This must only be invoked while holding the SB global lock @@ -924,7 +924,7 @@ extern CFE_SB_PipeD_t *CFE_SB_LocatePipeDescByID(CFE_SB_PipeId_t PipeId); /*---------------------------------------------------------------------------------------*/ /** - * @brief Check if an Pipe descriptor is in use or free/empty + * @brief Check if a Pipe descriptor is in use or free/empty * * This routine checks if the Pipe table entry is in use or if it is free * @@ -944,7 +944,7 @@ static inline bool CFE_SB_PipeDescIsUsed(const CFE_SB_PipeD_t *PipeDscPtr) /*---------------------------------------------------------------------------------------*/ /** - * @brief Get the ID value from an Pipe table entry + * @brief Get the ID value from a Pipe table entry * * This routine converts the table entry back to an abstract ID. * @@ -961,7 +961,7 @@ static inline CFE_SB_PipeId_t CFE_SB_PipeDescGetID(const CFE_SB_PipeD_t *PipeDsc /*---------------------------------------------------------------------------------------*/ /** - * @brief Marks an Pipe table entry as used (not free) + * @brief Marks a Pipe table entry as used (not free) * * This sets the internal field(s) within this entry, and marks * it as being associated with the given Pipe ID. @@ -982,7 +982,7 @@ static inline void CFE_SB_PipeDescSetUsed(CFE_SB_PipeD_t *PipeDscPtr, CFE_Resour /*---------------------------------------------------------------------------------------*/ /** - * @brief Set an Pipe descriptor table entry free (not used) + * @brief Set a Pipe descriptor table entry free (not used) * * This clears the internal field(s) within this entry, and allows the * memory to be re-used in the future. @@ -1002,7 +1002,7 @@ static inline void CFE_SB_PipeDescSetFree(CFE_SB_PipeD_t *PipeDscPtr) /*---------------------------------------------------------------------------------------*/ /** - * @brief Check if an Pipe descriptor is a match for the given PipeID + * @brief Check if a Pipe descriptor is a match for the given PipeID * * This routine confirms that the previously-located descriptor is valid * and matches the expected Pipe ID. diff --git a/modules/sb/fsw/src/cfe_sb_task.c b/modules/sb/fsw/src/cfe_sb_task.c index 5e66eff9a..6f8da5897 100644 --- a/modules/sb/fsw/src/cfe_sb_task.c +++ b/modules/sb/fsw/src/cfe_sb_task.c @@ -1215,7 +1215,7 @@ bool CFE_SB_WriteMsgMapInfoDataGetter(void *Meta, uint32 RecordNum, void **Buffe Throttle.MaxLoop = 1; Throttle.NextIndex = 0; - /* Set the MsgId intially - will be overwritten with real info in CFE_SB_CollectMsgMapInfo */ + /* Set the MsgId initially - will be overwritten with real info in CFE_SB_CollectMsgMapInfo */ BgFilePtr->Buffer.MsgMapInfo.MsgId = CFE_SB_INVALID_MSG_ID; /* Collect info on the next route (limited to one per cycle via throttle) */ @@ -1377,7 +1377,7 @@ int32 CFE_SB_SendPrevSubsCmd(const CFE_SB_SendPrevSubsCmd_t *data) CFE_SB_Global.PrevSubMsg.Payload.PktSegment = 1; CFE_SB_Global.PrevSubMsg.Payload.Entries = 0; - /* Send subcription for each route */ + /* Send subscription for each route */ CFE_SBR_ForEachRouteId(CFE_SB_SendRouteSub, NULL, NULL); CFE_SB_UnlockSharedData(__func__, __LINE__); diff --git a/modules/sb/ut-coverage/sb_UT.c b/modules/sb/ut-coverage/sb_UT.c index da88d7151..7405f2f80 100644 --- a/modules/sb/ut-coverage/sb_UT.c +++ b/modules/sb/ut-coverage/sb_UT.c @@ -49,7 +49,7 @@ * This allows each test routine to reported consistently as "GroupName.TestName" * * This also implicitly includes a call to SB_ResetUnitTest() as a setup function, - * so the test routines do _not_ need to do this explictly on every test case. + * so the test routines do _not_ need to do this explicitly on every test case. */ #define SB_UT_ADD_SUBTEST(Func) UtTest_AddSubTest(Func, SB_ResetUnitTest, NULL, __func__, #Func) @@ -128,7 +128,7 @@ CFE_ResourceId_t UT_SB_MakePipeIdForIndex(uint32 ArrayIdx) } /* - * Helper function to "corrupt" a resource ID value in a consistent/predicatble way, + * Helper function to "corrupt" a resource ID value in a consistent/predictable way, * which can also be un-done easily. */ CFE_ES_AppId_t UT_SB_AppID_Modify(CFE_ES_AppId_t InitialID, int32 Modifier) @@ -1456,7 +1456,7 @@ void Test_SB_Cmds_SendPrevSubs(void) /* Skip subscribing to ALLSUBS mid. This is the one we are testing. * MsgID for this in CCSDS v.1 was 0x180d so this MID did not appear in the * SB sub list. This results in multiple NO_SUBS_EID sent which we are not - * testing here so it is irrelevent + * testing here so it is irrelevant * For CCSDS v.2 CFE_SB_ALLSUBS_TLM_MID (0x0d) now appears in the * SB subscription list and thus we must skip adding 0x0D to the list * as we were going from MSGID 0-45 (0x00-0x2D) @@ -1885,7 +1885,7 @@ void Test_CreatePipe_SamePipeName(void) char PipeName[] = "Test_CFE_SB"; /* Need to make sure OS_QueueCreate() stub fails on second call */ - /* to mimick the failure expected when passing the same pipe name */ + /* to mimic the failure expected when passing the same pipe name */ UT_SetDeferredRetcode(UT_KEY(OS_QueueCreate), 2, OS_ERR_NAME_TAKEN); /* First call to CFE_SB_CreatePipe() should succeed */ @@ -2826,7 +2826,7 @@ void Test_Unsubscribe_NoMatch(void) CFE_UtAssert_EVENTSENT(CFE_SB_UNSUB_NO_SUBS_EID); UT_ClearEventHistory(); - /* Check that repeated unsubscribe to msgid that was subscribted reports error */ + /* Check that repeated unsubscribe to msgid that was subscribed reports error */ CFE_UtAssert_SUCCESS(CFE_SB_Unsubscribe(MsgId, TestPipe)); CFE_UtAssert_EVENTSENT(CFE_SB_UNSUB_NO_SUBS_EID); @@ -3729,7 +3729,7 @@ void Test_ReceiveBuffer_InvalidPipeId(void) /* * The internal call to OS_QueueGet is done with the SB global unlocked, as other tasks must be able * to access the SB global while another task is pending on a receive. Because of this lock/unlock/relock - * pattern, the CFE_SB_RecieveBuffer() function validates the pipeID twice, after each time it obtains the + * pattern, the CFE_SB_ReceiveBuffer() function validates the pipeID twice, after each time it obtains the * global SB lock. The second check is to cover the corner case that the pipeID was deleted or reconfigured * while it was pending. * @@ -4588,7 +4588,7 @@ void Test_SB_TransmitMsgPaths_IgnoreOpt(void) } /* end Test_SB_TransmitMsgPaths */ /* -** Test receiving a message response to a unsubscribing to message, then +** Test receiving a message response to an unsubscribing to message, then ** resubscribing to it while it's in the pipe */ void Test_ReceiveBuffer_UnsubResubPath(void) diff --git a/modules/sb/ut-coverage/sb_UT.h b/modules/sb/ut-coverage/sb_UT.h index 083402e6b..6b35f1d3e 100644 --- a/modules/sb/ut-coverage/sb_UT.h +++ b/modules/sb/ut-coverage/sb_UT.h @@ -566,11 +566,11 @@ void Test_GetPipeName_NullPtr(void); /*****************************************************************************/ /** -** \brief Test get pipe name by id response to an non-existant pipe id +** \brief Test get pipe name by id response to a non-existent pipe id ** ** \par Description ** This function tests the get pipe name by id command when -** called with a id that doesn't exist. +** called with an id that doesn't exist. ** ** \par Assumptions, External Events, and Notes: ** None @@ -629,7 +629,7 @@ void Test_GetPipeIdByName_NullPtrs(void); /*****************************************************************************/ /** -** \brief Test get pipe id by name response to an non-existant pipe name +** \brief Test get pipe id by name response to a non-existent pipe name ** ** \par Description ** This function tests the get pipe id by name command when diff --git a/modules/sbr/fsw/src/cfe_sbr_map_hash.c b/modules/sbr/fsw/src/cfe_sbr_map_hash.c index 924fd88da..a94c57d87 100644 --- a/modules/sbr/fsw/src/cfe_sbr_map_hash.c +++ b/modules/sbr/fsw/src/cfe_sbr_map_hash.c @@ -83,7 +83,7 @@ CFE_SBR_RouteId_t CFE_SBR_MSGMAP[CFE_SBR_MSG_MAP_SIZE]; * Hashes the message id * * Note: algorithm designed for a 32 bit int, changing the size of - * CFE_SB_MsgId_Atom_t may require an update to this impelementation + * CFE_SB_MsgId_Atom_t may require an update to this implementation * *-----------------------------------------------------------------*/ CFE_SB_MsgId_Atom_t CFE_SBR_MsgIdHash(CFE_SB_MsgId_t MsgId) diff --git a/modules/sbr/fsw/src/cfe_sbr_route_unsorted.c b/modules/sbr/fsw/src/cfe_sbr_route_unsorted.c index 0c9bdc108..a0dad2c7f 100644 --- a/modules/sbr/fsw/src/cfe_sbr_route_unsorted.c +++ b/modules/sbr/fsw/src/cfe_sbr_route_unsorted.c @@ -20,7 +20,7 @@ /****************************************************************************** * Purpose: - * Unsorted routing implemenation + * Unsorted routing implementation * Used with route map implementations where order of routes doesn't matter * * Notes: diff --git a/modules/sbr/ut-coverage/test_cfe_sbr_route_unsorted.c b/modules/sbr/ut-coverage/test_cfe_sbr_route_unsorted.c index c16ddecb4..bfd65a870 100644 --- a/modules/sbr/ut-coverage/test_cfe_sbr_route_unsorted.c +++ b/modules/sbr/ut-coverage/test_cfe_sbr_route_unsorted.c @@ -58,7 +58,7 @@ void Test_SBR_Route_Unsort_General(void) /* * Force valid msgid responses * Note from here on msgids must be in the valid range since validation is forced true - * and if the underlying map implentation is direct it needs to be a valid array index + * and if the underlying map implementation is direct it needs to be a valid array index */ UT_SetDefaultReturnValue(UT_KEY(CFE_SB_IsValidMsgId), true); @@ -136,7 +136,7 @@ void Test_SBR_Route_Unsort_GetSet(void) /* * Force valid msgid responses * Note from here on msgids must be in the valid range since validation is forced true - * and if the underlying map implentation is direct it needs to be a valid array index + * and if the underlying map implementation is direct it needs to be a valid array index */ UT_SetDefaultReturnValue(UT_KEY(CFE_SB_IsValidMsgId), true); diff --git a/modules/tbl/fsw/inc/cfe_tbl_events.h b/modules/tbl/fsw/inc/cfe_tbl_events.h index 380673c16..be0468ba2 100644 --- a/modules/tbl/fsw/inc/cfe_tbl_events.h +++ b/modules/tbl/fsw/inc/cfe_tbl_events.h @@ -39,7 +39,7 @@ * * \par Cause: * - * Table Services Taks initialization complete. + * Table Services Task initialization complete. */ #define CFE_TBL_INIT_INF_EID 1 @@ -131,7 +131,7 @@ * * \par Cause: * - * TBL load table pending notification sucessfully sent. + * TBL load table pending notification successfully sent. */ #define CFE_TBL_LOAD_PEND_REQ_INF_EID 17 @@ -177,7 +177,7 @@ * \par Cause: * * \link #CFE_TBL_VALIDATE_CC TBL Validate Table Command \endlink marking table - * as valid due to no validation functing being registered. + * as valid due to no validation function being registered. */ #define CFE_TBL_ASSUMED_VALID_INF_EID 23 @@ -188,7 +188,7 @@ * * \par Cause: * - * #CFE_TBL_Load API succes for dump only or normal table. OVERLOADED + * #CFE_TBL_Load API success for dump only or normal table. OVERLOADED */ #define CFE_TBL_LOAD_SUCCESS_INF_EID 35 @@ -199,7 +199,7 @@ * * \par Cause: * - * Table active or inactive image successfully validated by the registerd validation function. OVERLOADED + * Table active or inactive image successfully validated by the registered validation function. OVERLOADED */ #define CFE_TBL_VALIDATION_INF_EID 36 @@ -310,7 +310,7 @@ * * \par Cause: * - * TBL commamnd handler unable to find table name. OVERLOADED + * TBL command handler unable to find table name. OVERLOADED */ #define CFE_TBL_NO_SUCH_TABLE_ERR_EID 57 @@ -412,7 +412,7 @@ * * \link #CFE_TBL_VALIDATE_CC TBL Validate Table Command \endlink or * \link #CFE_TBL_DUMP_CC TBL Write Table Command \endlink failure due - * to requesting non-existant inactive buffer. OVERLOADED + * to requesting non-existent inactive buffer. OVERLOADED */ #define CFE_TBL_NO_INACTIVE_BUFFER_ERR_EID 66 diff --git a/modules/tbl/fsw/inc/cfe_tbl_msg.h b/modules/tbl/fsw/inc/cfe_tbl_msg.h index 38b53c4bc..7ea480fb5 100644 --- a/modules/tbl/fsw/inc/cfe_tbl_msg.h +++ b/modules/tbl/fsw/inc/cfe_tbl_msg.h @@ -597,7 +597,7 @@ typedef struct CFE_TBL_ActivateCmd_Payload typedef struct CFE_TBL_ActivateCmd { CFE_MSG_CommandHeader_t CmdHeader; /**< \brief Command header */ - CFE_TBL_ActivateCmd_Payload_t Payload; /**< \brief Command paylod */ + CFE_TBL_ActivateCmd_Payload_t Payload; /**< \brief Command payload */ } CFE_TBL_ActivateCmd_t; /** @@ -686,7 +686,7 @@ typedef struct CFE_TBL_AbortLoadCmd_Payload typedef struct CFE_TBL_AbortLoadCmd { CFE_MSG_CommandHeader_t CmdHeader; /**< \brief Command header */ - CFE_TBL_AbortLoadCmd_Payload_t Payload; /**< \brief Command paylod */ + CFE_TBL_AbortLoadCmd_Payload_t Payload; /**< \brief Command payload */ } CFE_TBL_AbortLoadCmd_t; /*************************************************************************/ diff --git a/modules/tbl/fsw/src/cfe_tbl_task.h b/modules/tbl/fsw/src/cfe_tbl_task.h index 90244636b..fde831dab 100644 --- a/modules/tbl/fsw/src/cfe_tbl_task.h +++ b/modules/tbl/fsw/src/cfe_tbl_task.h @@ -298,7 +298,7 @@ typedef struct /* ** Task housekeeping and diagnostics telemetry packets... */ - CFE_TBL_HousekeepingTlm_t HkPacket; /**< \brief Housekeping Telemetry Packet */ + CFE_TBL_HousekeepingTlm_t HkPacket; /**< \brief Housekeeping Telemetry Packet */ CFE_TBL_TableRegistryTlm_t TblRegPacket; /**< \brief Table Registry Entry Telemetry Packet */ CFE_TBL_NotifyCmd_t NotifyMsg; /**< \brief Table management notification command message */ diff --git a/modules/tbl/ut-coverage/tbl_UT.c b/modules/tbl/ut-coverage/tbl_UT.c index f59974be1..373d4ef7b 100644 --- a/modules/tbl/ut-coverage/tbl_UT.c +++ b/modules/tbl/ut-coverage/tbl_UT.c @@ -618,7 +618,7 @@ void Test_CFE_TBL_DumpToFile(void) UT_SetDeferredRetcode(UT_KEY(OS_OpenCreate), 1, OS_ERROR); UtAssert_INT32_EQ(CFE_TBL_DumpToFile("filename", "tablename", "dumpaddress", TblSizeInBytes), CFE_TBL_INC_CMD_CTR); - /* Test where file already exists so data isoverwritten */ + /* Test where file already exists so data is overwritten */ UT_InitData(); UtAssert_INT32_EQ(CFE_TBL_DumpToFile("filename", "tablename", "dumpaddress", TblSizeInBytes), CFE_TBL_INC_CMD_CTR); } @@ -1405,7 +1405,7 @@ void Test_CFE_TBL_Register(void) /* Test response to a table name longer than the maximum allowed */ UT_InitData(); - /* Create a table name longer than alowed */ + /* Create a table name longer than allowed */ for (i = 0; i < CFE_MISSION_TBL_MAX_NAME_LENGTH + 1; i++) { TblName[i] = 'A'; @@ -3393,7 +3393,7 @@ void Test_CFE_TBL_Internal(void) UtAssert_INT32_EQ(CFE_TBL_EarlyInit(), CFE_ES_BAD_ARGUMENT); CFE_UtAssert_EVENTCOUNT(0); - /* Test CFE_TBL_EarlyInit reponse to a get pool buffer failure */ + /* Test CFE_TBL_EarlyInit response to a get pool buffer failure */ UT_InitData(); UT_SetDeferredRetcode(UT_KEY(CFE_ES_GetPoolBuf), 1, CFE_ES_ERR_RESOURCEID_NOT_VALID); UtAssert_INT32_EQ(CFE_TBL_EarlyInit(), CFE_ES_ERR_RESOURCEID_NOT_VALID); diff --git a/modules/time/fsw/inc/cfe_time_events.h b/modules/time/fsw/inc/cfe_time_events.h index bbd6d4d50..b9290df05 100644 --- a/modules/time/fsw/inc/cfe_time_events.h +++ b/modules/time/fsw/inc/cfe_time_events.h @@ -274,7 +274,7 @@ * \par Cause: * * \link #CFE_TIME_ADD_DELAY_CC TIME Add Tone Delay Command \endlink OR - * \link #CFE_TIME_SUB_DELAY_CC TIME Subtract Tone Delay Command \endlink falure + * \link #CFE_TIME_SUB_DELAY_CC TIME Subtract Tone Delay Command \endlink failure * due to an invalid time value. */ #define CFE_TIME_DELAY_ERR_EID 33 @@ -324,7 +324,7 @@ * * \link #CFE_TIME_ADD_ADJUST_CC TIME Add Single STCF Adjustment Command \endlink * OR \link #CFE_TIME_SUB_ADJUST_CC TIME Subtract Single STCF Adjustment Command \endlink - * falure due to an invalid time value. + * failure due to an invalid time value. */ #define CFE_TIME_DELTA_ERR_EID 37 diff --git a/modules/time/fsw/inc/cfe_time_msg.h b/modules/time/fsw/inc/cfe_time_msg.h index 2bebb1d97..9810dcd12 100644 --- a/modules/time/fsw/inc/cfe_time_msg.h +++ b/modules/time/fsw/inc/cfe_time_msg.h @@ -289,7 +289,7 @@ ** ** \par Error Conditions ** - An invalid number of microseconds was specified (must be less than 1 million) -** - Platorm receiving the command is not a Time Client +** - Platform receiving the command is not a Time Client **

        Evidence of Failure may be found in the following telemetry: ** - \b \c \TIME_CMDEC - command error counter will increment ** - Error specific event messages will be issued (#CFE_TIME_DELAY_CFG_EID or #CFE_TIME_DELAY_ERR_EID) @@ -327,7 +327,7 @@ ** ** \par Error Conditions ** - An invalid number of microseconds was specified (must be less than 1 million) -** - Platorm receiving the command is not a Time Client +** - Platform receiving the command is not a Time Client **

        Evidence of Failure may be found in the following telemetry: ** - \b \c \TIME_CMDEC - command error counter will increment ** - Error specific event messages will be issued (#CFE_TIME_DELAY_CFG_EID or #CFE_TIME_DELAY_ERR_EID) @@ -355,7 +355,7 @@ ** - (current time) = (current MET) + STCF **

        If Time Service is configured to compute current time as UTC ** - STCF = ((new time) - (current MET)) + (Leap Seconds) -** - (current time) = ((curent MET) + STCF) - (Leap Seconds) +** - (current time) = ((current MET) + STCF) - (Leap Seconds) ** ** \cfecmdmnemonic \TIME_SETCLOCK ** @@ -372,7 +372,7 @@ ** ** \par Error Conditions ** - An invalid number of microseconds was specified (must be less than 1 million) -** - Platorm receiving the command is not a Time Server +** - Platform receiving the command is not a Time Server **

        Evidence of Failure may be found in the following telemetry: ** - \b \c \TIME_CMDEC - command error counter will increment ** - Error specific event messages will be issued (#CFE_TIME_TIME_CFG_EID or #CFE_TIME_TIME_ERR_EID) @@ -412,7 +412,7 @@ ** ** \par Error Conditions ** - An invalid number of microseconds was specified (must be less than 1 million) -** - Platorm receiving the command is not a Time Server +** - Platform receiving the command is not a Time Server **

        Evidence of Failure may be found in the following telemetry: ** - \b \c \TIME_CMDEC - command error counter will increment ** - Error specific event messages will be issued (#CFE_TIME_MET_CFG_EID or #CFE_TIME_MET_ERR_EID) @@ -449,7 +449,7 @@ ** ** \par Error Conditions ** - An invalid number of microseconds was specified (must be less than 1 million) -** - Platorm receiving the command is not a Time Server +** - Platform receiving the command is not a Time Server **

        Evidence of Failure may be found in the following telemetry: ** - \b \c \TIME_CMDEC - command error counter will increment ** - Error specific event messages will be issued (#CFE_TIME_STCF_CFG_EID or #CFE_TIME_STCF_ERR_EID) @@ -484,7 +484,7 @@ ** - The #CFE_TIME_LEAPS_EID informational event message will be generated ** ** \par Error Conditions -** - Platorm receiving the command is not a Time Server +** - Platform receiving the command is not a Time Server **

        Evidence of Failure may be found in the following telemetry: ** - \b \c \TIME_CMDEC - command error counter will increment ** - Error specific event messages will be issued (#CFE_TIME_LEAPS_CFG_EID) @@ -519,7 +519,7 @@ ** ** \par Error Conditions ** - An invalid number of microseconds was specified (must be less than 1 million) -** - Platorm receiving the command is not a Time Server +** - Platform receiving the command is not a Time Server **

        Evidence of Failure may be found in the following telemetry: ** - \b \c \TIME_CMDEC - command error counter will increment ** - Error specific event messages will be issued (#CFE_TIME_DELTA_ERR_EID or #CFE_TIME_DELTA_CFG_EID) @@ -554,7 +554,7 @@ ** ** \par Error Conditions ** - An invalid number of microseconds was specified (must be less than 1 million) -** - Platorm receiving the command is not a Time Server +** - Platform receiving the command is not a Time Server **

        Evidence of Failure may be found in the following telemetry: ** - \b \c \TIME_CMDEC - command error counter will increment ** - Error specific event messages will be issued (#CFE_TIME_DELTA_ERR_EID or #CFE_TIME_DELTA_CFG_EID) @@ -600,7 +600,7 @@ ** - The #CFE_TIME_1HZ_EID informational event message will be generated ** ** \par Error Conditions -** - Platorm receiving the command is not a Time Server +** - Platform receiving the command is not a Time Server **

        Evidence of Failure may be found in the following telemetry: ** - \b \c \TIME_CMDEC - command error counter will increment ** - Error specific event message will be issued (#CFE_TIME_1HZ_CFG_EID) @@ -648,7 +648,7 @@ ** - The #CFE_TIME_1HZ_EID informational event message will be generated ** ** \par Error Conditions -** - Platorm receiving the command is not a Time Server +** - Platform receiving the command is not a Time Server **

        Evidence of Failure may be found in the following telemetry: ** - \b \c \TIME_CMDEC - command error counter will increment ** - Error specific event message will be issued (#CFE_TIME_1HZ_CFG_EID) diff --git a/modules/time/fsw/src/cfe_time_tone.c b/modules/time/fsw/src/cfe_time_tone.c index 22d8f0fac..bddb2de65 100644 --- a/modules/time/fsw/src/cfe_time_tone.c +++ b/modules/time/fsw/src/cfe_time_tone.c @@ -1040,7 +1040,7 @@ void CFE_TIME_Tone1HzISR(void) */ CFE_TIME_Global.ToneIntCounter++; - /* Since the tone occured ~1 seonds after the previous one, we + /* Since the tone occurred ~1 seconds after the previous one, we ** can mark this tone as 'good' */ CFE_TIME_Global.IsToneGood = true; @@ -1073,7 +1073,7 @@ void CFE_TIME_Tone1HzISR(void) */ CFE_TIME_Global.ToneIntErrorCounter++; - /* Since the tone didn't occur ~1 seonds after the previous one, we + /* Since the tone didn't occur ~1 seconds after the previous one, we ** can mark this tone as 'not good' */ CFE_TIME_Global.IsToneGood = false; diff --git a/modules/time/fsw/src/cfe_time_utils.c b/modules/time/fsw/src/cfe_time_utils.c index 6b096ee94..0e8aafee8 100644 --- a/modules/time/fsw/src/cfe_time_utils.c +++ b/modules/time/fsw/src/cfe_time_utils.c @@ -621,7 +621,7 @@ void CFE_TIME_GetReference(CFE_TIME_Reference_t *Reference) /* * This should really never happen: if RetryCount reaches its limit, it means something is - * continously changing the time structure to the point where this task was not able to + * continuously changing the time structure to the point where this task was not able to * get a consistent copy. The only way this could happen is if some update task got into * a continuous loop, or if the memory itself has gone bad and reads inconsistently. But * if the latter is the case, the whole system has undefined behavior. diff --git a/modules/time/fsw/src/cfe_time_utils.h b/modules/time/fsw/src/cfe_time_utils.h index ec08f7aa6..657371257 100644 --- a/modules/time/fsw/src/cfe_time_utils.h +++ b/modules/time/fsw/src/cfe_time_utils.h @@ -72,7 +72,7 @@ #define CFE_TIME_TASK_PIPE_DEPTH 12 /* -** Reset Area state state at startup... +** Reset Area state at startup... */ #define CFE_TIME_RESET_AREA_ERROR 1 /* no mem available */ @@ -112,7 +112,7 @@ typedef struct int16 AtToneLeapSeconds; /* Leap Seconds at time of tone */ int16 ClockSetState; /* Time has been "set" */ int16 ClockFlyState; /* Current fly-wheel state */ - int16 DelayDirection; /* Wheter "AtToneDelay" is add or subtract */ + int16 DelayDirection; /* Whether "AtToneDelay" is add or subtract */ CFE_TIME_SysTime_t AtToneDelay; /* Adjustment for slow tone detection */ CFE_TIME_SysTime_t AtToneLatch; /* Local clock latched at time of tone */ CFE_TIME_SysTime_t CurrentLatch; /* Local clock latched just "now" */ diff --git a/modules/time/ut-coverage/time_UT.c b/modules/time/ut-coverage/time_UT.c index e578caec0..1f5016532 100644 --- a/modules/time/ut-coverage/time_UT.c +++ b/modules/time/ut-coverage/time_UT.c @@ -129,8 +129,8 @@ void OS_SelectTone(int16 Signal) {} #endif /* - * A hook functions for CFE_PSP_GetTime that updates the Reference State. - * This mimmics what would happen if a time update occurred at the moment + * A hook function for CFE_PSP_GetTime that updates the Reference State. + * This mimics what would happen if a time update occurred at the moment * another task was reading the time. */ int32 UT_TimeRefUpdateHook(void *UserObj, int32 StubRetcode, uint32 CallCount, const UT_StubContext_t *Context) From 94fdd22e02cf6ea08e1ab4d00008f693015f78e0 Mon Sep 17 00:00:00 2001 From: Avi Date: Wed, 1 Sep 2021 18:29:43 +0200 Subject: [PATCH 3/4] Fixed typo in error text string in GitHub automated workflow. --- .github/workflows/functional-tests.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/functional-tests.yml b/.github/workflows/functional-tests.yml index 0241f2b1e..0cda3b2fc 100644 --- a/.github/workflows/functional-tests.yml +++ b/.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 From ffb4436e86be8c93778bf711ac9359e4f1f19caa Mon Sep 17 00:00:00 2001 From: Avi Date: Wed, 1 Sep 2021 18:31:13 +0200 Subject: [PATCH 4/4] Fixed minor text typos in source code (test/error messages). --- modules/core_private/ut-stubs/src/ut_osprintf_stubs.c | 4 ++-- modules/es/fsw/src/cfe_es_start.c | 4 ++-- modules/sb/fsw/src/cfe_sb_api.c | 2 +- modules/sbr/ut-coverage/test_cfe_sbr_route_unsorted.c | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/modules/core_private/ut-stubs/src/ut_osprintf_stubs.c b/modules/core_private/ut-stubs/src/ut_osprintf_stubs.c index ddb5bfcd6..5a6af8b28 100644 --- a/modules/core_private/ut-stubs/src/ut_osprintf_stubs.c +++ b/modules/core_private/ut-stubs/src/ut_osprintf_stubs.c @@ -64,7 +64,7 @@ const char *UT_OSP_MESSAGES[] = { [UT_OSP_LIBRARY_SLOTS] = "%s: No free library slots available\n", [UT_OSP_EXTRACT_FILENAME_UT] = "%s: Unable to extract filename from path: %s.\n", [UT_OSP_APP_PATH_FILE_TOO_LONG] = "%s: Application path plus file name length (%d) exceeds max allowed (%d)\n", - [UT_OSP_REFORMAT_VOLATILE] = "%s: Error Re-Formating Volatile(RAM) Volume. EC = %ld\n", + [UT_OSP_REFORMAT_VOLATILE] = "%s: Error Re-Formatting Volatile(RAM) Volume. EC = %ld\n", [UT_OSP_EXTRACT_FILENAME_UT55] = "%s: Could not load file:%s. EC = %ld\n", [UT_OSP_EXTRACT_FILENAME_UT46] = "%s: Unable to extract filename from path: %s.\n", [UT_OSP_NO_FREE_APP_SLOTS] = "%s: No free application slots available\n", @@ -75,7 +75,7 @@ const char *UT_OSP_MESSAGES[] = { [UT_OSP_APP_INIT] = "%s: Application Init Failed,RC=0x%08X\n", [UT_OSP_POR_MAX_PROC_RESETS] = "%s: POWER ON RESET due to max proc resets (Commanded).\n", [UT_OSP_CANNOT_RESTART_APP] = "%s: Cannot Restart Application %s, It is not running.\n", - [UT_OSP_INSUFF_FREE_SPACE] = "%s: Insufficent Free Space on Volatile Disk, Reformatting.\n", + [UT_OSP_INSUFF_FREE_SPACE] = "%s: Insufficient Free Space on Volatile Disk, Reformatting.\n", [UT_OSP_LOAD_SHARED_LIBRARY] = "%s: Could not load cFE Shared Library\n", [UT_OSP_POR_HW_SPECIAL] = "%s: POWER ON RESET due to HW Special Cmd (Hw Spec Cmd).\n", [UT_OSP_APP_CREATE] = "%s: AppCreate Error: TaskCreate %s Failed. EC = %ld!\n", diff --git a/modules/es/fsw/src/cfe_es_start.c b/modules/es/fsw/src/cfe_es_start.c index f20a1fa3e..1a9366343 100644 --- a/modules/es/fsw/src/cfe_es_start.c +++ b/modules/es/fsw/src/cfe_es_start.c @@ -595,7 +595,7 @@ void CFE_ES_InitializeFileSystems(uint32 StartType) if (PercentFree < CFE_PLATFORM_ES_RAM_DISK_PERCENT_RESERVED) { - CFE_ES_WriteToSysLog("%s: Insufficent Free Space on Volatile Disk, Reformatting.\n", __func__); + CFE_ES_WriteToSysLog("%s: Insufficient Free Space on Volatile Disk, Reformatting.\n", __func__); /* ** First, unmount the disk @@ -641,7 +641,7 @@ void CFE_ES_InitializeFileSystems(uint32 StartType) else { - CFE_ES_WriteToSysLog("%s: Error Re-Formating Volatile(RAM) Volume. EC = %ld\n", __func__, + CFE_ES_WriteToSysLog("%s: Error Re-Formatting Volatile(RAM) Volume. EC = %ld\n", __func__, (long)OsStatus); /* ** Delay to allow the message to be read diff --git a/modules/sb/fsw/src/cfe_sb_api.c b/modules/sb/fsw/src/cfe_sb_api.c index b3a24a701..fb5f119be 100644 --- a/modules/sb/fsw/src/cfe_sb_api.c +++ b/modules/sb/fsw/src/cfe_sb_api.c @@ -1301,7 +1301,7 @@ int32 CFE_SB_UnsubscribeFull(CFE_SB_MsgId_t MsgId, CFE_SB_PipeId_t PipeId, uint8 case CFE_SB_UNSUB_ARG_ERR_EID: CFE_EVS_SendEventWithAppID(CFE_SB_UNSUB_ARG_ERR_EID, CFE_EVS_EventType_ERROR, CFE_SB_Global.AppId, - "UnSubscribe Err:Bad Arg,MsgId 0x%x,PipeId %lu,app %s,scope %d", + "Unsubscribe Err:Bad Arg,MsgId 0x%x,PipeId %lu,app %s,scope %d", (unsigned int)CFE_SB_MsgIdToValue(MsgId), CFE_RESOURCEID_TO_ULONG(PipeId), CFE_SB_GetAppTskName(TskId, FullName), (int)Scope); break; diff --git a/modules/sbr/ut-coverage/test_cfe_sbr_route_unsorted.c b/modules/sbr/ut-coverage/test_cfe_sbr_route_unsorted.c index bfd65a870..ac42a031e 100644 --- a/modules/sbr/ut-coverage/test_cfe_sbr_route_unsorted.c +++ b/modules/sbr/ut-coverage/test_cfe_sbr_route_unsorted.c @@ -67,7 +67,7 @@ void Test_SBR_Route_Unsort_General(void) CFE_SBR_ForEachRouteId(Test_SBR_Callback, &count, NULL); UtAssert_INT32_EQ(count, 0); - UtPrintf("Add maximum mesage id value"); + UtPrintf("Add maximum message id value"); msgid = CFE_SB_ValueToMsgId(CFE_PLATFORM_SB_HIGHEST_VALID_MSGID); routeid = CFE_SBR_AddRoute(msgid, &collisions); UtAssert_INT32_EQ(collisions, 0);