From 8d4511b62bdc59e115c4db3d7bc44ae27d1f2ada Mon Sep 17 00:00:00 2001 From: Avi Date: Wed, 1 Sep 2021 18:04:38 +0200 Subject: [PATCH] Fix #1915, Correct documentation typos Also fix typos 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