Fix #2413, Update Dev Guide to fix out-of-date references and broken

links

Author: thnkslprpt

docs/README_functionaltest.md

@@ -19,10 +19,6 @@ This must be the first library loaded for any functional test.
 - `cfe_testcase`: a CFE-compatible library implementing test cases for CFE core apps.
 This must be loaded after `cfe_assert`.
 
-- `cfe_testrunner`: a CFE application that actually executes the tests.  This is a very
-simple app that waits for CFE startup to complete, then executes all registered test
-cases.  It also must be loaded after `cfe_assert`.
-
 
 ## Example startup script entries
 

docs/cFE Application Developers Guide.md

@@ -163,7 +163,7 @@
   \ref cfeevsugmsgfilter (only the Binary Filtering Scheme
   exists currently).   Note that applications are limited in the number of events that
   they can register for filtering (see #CFE_PLATFORM_EVS_MAX_EVENT_FILTERS in cfe_platform_cfg.h
-  for the mission defined limit).  The filtering method uses a mask to determine if the
+  for the mission-defined limit).  The filtering method uses a mask to determine if the
   message is forwarded to the software bus, making it available in telemetry (see
   \ref cfeevsugmsgfilter for a description on filtering).  Commands are available to
   \link #CFE_EVS_SET_FILTER_CC modify the filter mask \endlink for any registered event.

docs/src/cfe_evs.dox

@@ -106,10 +106,10 @@
 
    \section cfebackground_s1 Core Flight Executive (cFE) Goals
 
-   The main long term goal of the cFE is to form the basis for a platform and project
+   The main long-term goal of the cFE is to form the basis for a platform and project
    independent reusable software framework. The cFE with the OSAL allow the development
    of portable embedded system software that is independent of a particular Real Time
-   Operating System and hardware platform. A secondary long term goal is to create a
+   Operating System and hardware platform. A secondary long-term goal is to create a
    standardized, product-line approach for development of embedded aerospace flight
    software. <BR>
 
@@ -121,7 +121,7 @@
    promoting the growth of the application and library layers where new applications, libraries,
    tools, and lessons learned can be contributed and shared. <BR>
 
-   It is important for application developers to realize the long term and functional
+   It is important for application developers to realize the long-term and functional
    goals of the cFE.  With a standard set of services providing a standard API, all
    applications developed with the cFE have an opportunity to become useful on
    future missions through code reuse.  In order to achieve this goal,

docs/src/cfe_frontpage.dox

@@ -44,7 +44,7 @@
              cFE following a Processor Reset.
      <TR>
         <TD> \anchor cfeadg_crc Cyclic Redundancy Check
-        <TD> A polynomial based method for checking that a data set
+        <TD> A polynomial-based method for checking that a data set
              has remained unchanged from one time period to another.
      <TR>
         <TD> \anchor cfeadg_developer Developer

docs/src/cfe_glossary.dox

@@ -116,7 +116,7 @@
   The default table type for a cFE Application to use is a single buffered table.  The principle
   advantage of a single buffered table is that it can share one of several shared table buffers
   for uploaded and pending table images.  Since many cFE Applications have relatively small tables
-  that are not changed at time critical moments or are not changed very often during a mission,
+  that are not changed at time-critical moments or are not changed very often during a mission,
   single buffered tables represent the most memory resource efficient method of being managed.
 
   The number of single buffered tables that can have inactive table images being manipulated at one

docs/src/cfe_tbl.dox

@@ -68,7 +68,7 @@
   easily be manipulated and utilized. These components include:
 
   The <B>Ground Epoch</B> is an arbitrary date and time that establishes the zero point
-  for spacecraft time calculations.  The selection of the epoch is mission specific,
+  for spacecraft time calculations.  The selection of the epoch is mission-specific,
   although in the past, it was common to select the same epoch as defined for the
   Operating System used by the computers hosting the ground system software.  Recent
   mission epoch selections have also included using zero seconds after midnight,
@@ -247,7 +247,7 @@
   #define CFE_MISSION_TIME_CFG_DEFAULT_UTC  TRUE
   \endverbatim
 
-  The choice of time format is a mission specific decision and is not directly
+  The choice of time format is a mission-specific decision and is not directly
   affected by the hardware configuration.
 
   \sa #CFE_MISSION_TIME_CFG_DEFAULT_TAI, #CFE_MISSION_TIME_CFG_DEFAULT_UTC <BR>
@@ -659,7 +659,7 @@
   to the current STCF.  In addition there is a 1Hz adjustment
   (#CFE_TIME_ADD_1HZ_ADJUSTMENT_CC and #CFE_TIME_SUB_1HZ_ADJUSTMENT_CC)
   that can be made to the STCF to compensate for oscillator drift.
-  Mission specific ground correlation should be used to assist in
+  Mission-specific ground correlation should be used to assist in
   determining the proper values to use. The Leap Seconds should be
   set to the current TAI-UTC. Note that the International Earth
   Rotation and Reference Systems Service Bulletin C, which defines

docs/src/cfe_time.dox

@@ -1,6 +1,6 @@
 #---------------------------------------------------------------------------
 # Each of the following assignment statements should have the documentation
-# mnemonic on the left followed by the mission specific command mnemonic
+# mnemonic on the left followed by the mission-specific command mnemonic
 # on the right of the equals operator.
 #
 # FORMATTING DETAILS TO REMEMBER!

docs/src/mnem_maps/cfe_es_cmd_mnem_map

@@ -1,6 +1,6 @@
 #---------------------------------------------------------------------------
 # Each of the following assignment statements should have the documentation
-# mnemonic on the left followed by the mission specific telemetry mnemonic
+# mnemonic on the left followed by the mission-specific telemetry mnemonic
 # on the right of the equals operator.
 #
 # FORMATTING DETAILS TO REMEMBER!

docs/src/mnem_maps/cfe_es_tlm_mnem_map

@@ -1,6 +1,6 @@
 #---------------------------------------------------------------------------
 # Each of the following assignment statements should have the documentation
-# mnemonic on the left followed by the mission specific command mnemonic
+# mnemonic on the left followed by the mission-specific command mnemonic
 # on the right of the equals operator.
 #
 # FORMATTING DETAILS TO REMEMBER!

docs/src/mnem_maps/cfe_evs_cmd_mnem_map

@@ -1,6 +1,6 @@
 #---------------------------------------------------------------------------
 # Each of the following assignment statements should have the documentation
-# mnemonic on the left followed by the mission specific telemetry mnemonic
+# mnemonic on the left followed by the mission-specific telemetry mnemonic
 # on the right of the equals operator.
 #
 # FORMATTING DETAILS TO REMEMBER!

docs/src/mnem_maps/cfe_evs_tlm_mnem_map

@@ -1,6 +1,6 @@
 #---------------------------------------------------------------------------
 # Each of the following assignment statements should have the documentation
-# mnemonic on the left followed by the mission specific command mnemonic
+# mnemonic on the left followed by the mission-specific command mnemonic
 # on the right of the equals operator.
 #
 # FORMATTING DETAILS TO REMEMBER!

docs/src/mnem_maps/cfe_sb_cmd_mnem_map

@@ -1,6 +1,6 @@
 #---------------------------------------------------------------------------
 # Each of the following assignment statements should have the documentation
-# mnemonic on the left followed by the mission specific telemetry mnemonic
+# mnemonic on the left followed by the mission-specific telemetry mnemonic
 # on the right of the equals operator.
 #
 # FORMATTING DETAILS TO REMEMBER!

docs/src/mnem_maps/cfe_sb_tlm_mnem_map

@@ -1,6 +1,6 @@
 #---------------------------------------------------------------------------
 # Each of the following assignment statements should have the documentation
-# mnemonic on the left followed by the mission specific command mnemonic
+# mnemonic on the left followed by the mission-specific command mnemonic
 # on the right of the equals operator.
 #
 # FORMATTING DETAILS TO REMEMBER!

docs/src/mnem_maps/cfe_tbl_cmd_mnem_map

@@ -1,6 +1,6 @@
 #---------------------------------------------------------------------------
 # Each of the following assignment statements should have the documentation
-# mnemonic on the left followed by the mission specific telemetry mnemonic
+# mnemonic on the left followed by the mission-specific telemetry mnemonic
 # on the right of the equals operator.
 #
 # FORMATTING DETAILS TO REMEMBER!

docs/src/mnem_maps/cfe_tbl_tlm_mnem_map

@@ -1,6 +1,6 @@
 #---------------------------------------------------------------------------
 # Each of the following assignment statements should have the documentation
-# mnemonic on the left followed by the mission specific command mnemonic
+# mnemonic on the left followed by the mission-specific command mnemonic
 # on the right of the equals operator.
 #
 # FORMATTING DETAILS TO REMEMBER!

docs/src/mnem_maps/cfe_time_cmd_mnem_map

@@ -1,6 +1,6 @@
 #---------------------------------------------------------------------------
 # Each of the following assignment statements should have the documentation
-# mnemonic on the left followed by the mission specific telemetry mnemonic
+# mnemonic on the left followed by the mission-specific telemetry mnemonic
 # on the right of the equals operator.
 #
 # FORMATTING DETAILS TO REMEMBER!

docs/src/mnem_maps/cfe_time_tlm_mnem_map

@@ -39,7 +39,7 @@
   </Package>
 
   <Package name="CFE_FS" shortDescription="File Services Configuration">
-     <Define name="FILE_CONTENT_ID" value="0x63464531" shortDescription="Magic Number for cFE compliant files (= cFE1)" />
+     <Define name="FILE_CONTENT_ID" value="0x63464531" shortDescription="Magic Number for cFE-compliant files (= cFE1)" />
   </Package>
 
   <Package name="CFE_SB" shortDescription="Software Bus Configuration">

modules/core_api/eds/config.xml

@@ -104,7 +104,7 @@ char *CFE_ES_StatusToString(CFE_Status_t status, CFE_StatusString_t *status_stri
 **      Mission Defined - These bits are available for Mission
 **                        specific coding standards.  They can
 **                        be used to classify error codes related
-**                        to mission specific library function calls, etc.
+**                        to mission-specific library function calls, etc.
 **
 **      Code - is the status code
 */

modules/core_api/fsw/inc/cfe_error.h

@@ -70,7 +70,7 @@
 **
 ** \param[in] Name                 The raw table name.  This name will be combined with the name of the
 **                                 application to produce a name of the form "AppName.RawTableName".
-**                                 This application specific name will be used in commands
+**                                 This application-specific name will be used in commands
 **                                 for modifying or viewing the contents of the table.
 **
 ** \param[in] Size                 The size, in bytes, of the table to be created @nonzero.  This is the size that will
@@ -105,7 +105,7 @@
 **                                                                 the pointer to the "active" table is changed to
 **                                                                 point to the "inactive" buffer thus making it
 **                                                                 the new "active" buffer.  This feature is most
-**                                                                 useful for time critical applications (ie -
+**                                                                 useful for time-critical applications (ie -
 **                                                                 interrupt service routines, etc).  This option is
 **                                                                 mutually exclusive with the
 **                                                                 #CFE_TBL_OPT_SNGL_BUFFER and #CFE_TBL_OPT_DEFAULT
@@ -209,7 +209,7 @@ CFE_Status_t CFE_TBL_Register(CFE_TBL_Handle_t *TblHandlePtr, const char *Name,
 **                           identify table to cFE when performing Table operations.
 **                           This value is returned at the address specified by TblHandlePtr.
 **
-** \param[in]  TblName       The application specific name of the table of the form "AppName.RawTableName",
+** \param[in]  TblName       The application-specific name of the table of the form "AppName.RawTableName",
 **                           where RawTableName is the name specified in the #CFE_TBL_Register API call.
 **                           Example: "ACS.TamParams" for a table called "TamParams"
 **                           that was registered by the application called "ACS".
@@ -688,7 +688,7 @@ CFE_Status_t CFE_TBL_GetStatus(CFE_TBL_Handle_t TblHandle);
 **                           with table characteristics and information. *TblInfoPtr is the description of the tables
 **                           characteristics and registry information stored in the #CFE_TBL_Info_t data structure
 **                           format.
-** \param[in]  TblName       The application specific name @nonnull of the table of the form "AppName.RawTableName",
+** \param[in]  TblName       The application-specific name @nonnull of the table of the form "AppName.RawTableName",
 **                           where RawTableName is the name specified in the #CFE_TBL_Register API call.
 **                           Example: "ACS.TamParams" for a table called "TamParams"
 **                           that was registered by the application called "ACS".

modules/core_api/fsw/inc/cfe_tbl.h

@@ -39,7 +39,7 @@
   </Package>
 
   <Package name="CFE_FS" shortDescription="File Services Configuration">
-     <Define name="FILE_CONTENT_ID" value="0x63464531" shortDescription="Magic Number for cFE compliant files (= cFE1)" />
+     <Define name="FILE_CONTENT_ID" value="0x63464531" shortDescription="Magic Number for cFE-compliant files (= cFE1)" />
   </Package>
 
   <Package name="CFE_SB" shortDescription="Software Bus Configuration">

modules/core_private/eds/config.xml

@@ -303,12 +303,12 @@
 */
 #define CFE_ES_RESTART_APP_CC 6
 
-/** \cfeescmd Stops, Unloads, Loads from the command specified 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
 **       from the system.  Then it immediately loads the Application from
-**       the command specified file and restarts it.  This command is
+**       the command-specified file and restarts it.  This command is
 **       especially useful for restarting a Command Ingest Application
 **       since once it has been stopped, no further commands can come in
 **       to restart it.
@@ -845,7 +845,7 @@
 **       - \b \c \ES_CMDPC - command execution counter will
 **         increment
 **       - \b \c \ES_MAXPROCRESETS - Current maximum number of processor resets
-**         before an automatic power-on reset will go to the command specified value.
+**         before an automatic power-on reset will go to the command-specified value.
 **       - The #CFE_ES_SET_MAX_PR_COUNT_EID informational event message will be
 **         generated.
 **

modules/es/config/default_cfe_es_fcncodes.h

@@ -238,7 +238,7 @@
 **       Defines the ram disk sector size. The ram disk is 1 of 4 memory areas that
 **       are preserved on a processor reset.
 **       NOTE: Changing this value changes memory allocation, and may
-**       require changes to platform specific values (in CFE_PSP) such as
+**       require changes to platform-specific values (in CFE_PSP) such as
 **       USER_RESERVED_MEM in VxWorks depending on the memory areas
 **       being used for preserved data and on OS specific behavior.
 **
@@ -256,7 +256,7 @@
 **       Defines the ram disk number of sectors. The ram disk is one of four memory
 **       areas that are preserved on a processor reset.
 **       NOTE: Changing this value changes memory allocation, and may
-**       require changes to platform specific values (in CFE_PSP) such as
+**       require changes to platform-specific values (in CFE_PSP) such as
 **       USER_RESERVED_MEM in VxWorks depending on the memory areas
 **       being used for preserved data and on OS specific behavior.
 **
@@ -298,7 +298,7 @@
 **       Defines the Critical Data Store (CDS) area size in bytes size. The CDS is
 **       one of four memory areas that are preserved during a processor reset.
 **       NOTE: Changing this value changes memory allocation, and may
-**       require changes to platform specific values (in CFE_PSP) such as
+**       require changes to platform-specific values (in CFE_PSP) such as
 **       USER_RESERVED_MEM in VxWorks depending on the memory areas
 **       being used for preserved data and on OS specific behavior.
 **
@@ -318,7 +318,7 @@
 **       #CFE_PSP_GetUserReservedArea. The User Reserved Memory is one of four memory
 **       areas that are preserved during a processor reset.
 **       NOTE: Changing this value changes memory allocation, and may
-**       require changes to platform specific values (in CFE_PSP) such as
+**       require changes to platform-specific values (in CFE_PSP) such as
 **       USER_RESERVED_MEM in VxWorks depending on the memory areas
 **       being used for preserved data and on OS specific behavior.
 **

modules/es/config/default_cfe_es_internal_cfg.h

@@ -80,7 +80,7 @@ int32 CFE_ES_CDS_EarlyInit(void)
         return CFE_STATUS_EXTERNAL_RESOURCE_FAIL;
     }
 
-    /* Always truncate the size to the nearest 4 byte boundary */
+    /* Always truncate the size to the nearest 4-byte boundary */
     CDS->TotalSize = PlatformSize & 0xfffffffc;
 
     /* Compute the minimum size required for the CDS with the current configuration of the cFE */