HOTFIX 20200902, update documentation links for deprecated symbols

Use of some deprecated symbols as links in documentation was causing warnings
to be generated after removal of these times.  This removes/fixes those links.

cmake/sample_defs/cpu1_platform_cfg.h

@@ -887,7 +887,7 @@
 **       reconstructed by the ground system.
 **
 **  \par Limits
-**       There is a lower limit of 32 and an upper limit of #CFE_SB_MAX_SB_MSG_SIZE.
+**       There is a lower limit of 32 and an upper limit of #CFE_MISSION_SB_MAX_SB_MSG_SIZE.
 */
 #define CFE_PLATFORM_ES_MAX_SHELL_PKT    64
 

docs/cFE Application Developers Guide.md

@@ -1121,14 +1121,14 @@ TypeCRC identifies which of the standard CRC polynomials to be used.  Currently,
 there are the following types available:
 
 ```
-CFE_ES_CRC_8 – an 8-bit additive checksum calculation that returns a 32-bit value
-CFE_ES_CRC_16 – a 16-bit additive checksum calculation that returns a 32-bit value
-CFE_ES_CRC_32 – a 32-bit additive checksum calculation that returns a 32-bit value
-CFE_ES_DEFAULT_CRC – the mission specified default CRC calculation
+CFE_MISSION_ES_CRC_8 – an 8-bit additive checksum calculation that returns a 32-bit value
+CFE_MISSION_ES_CRC_16 – a 16-bit additive checksum calculation that returns a 32-bit value
+CFE_MISSION_ES_CRC_32 – a 32-bit additive checksum calculation that returns a 32-bit value
+CFE_MISSION_ES_DEFAULT_CRC – the mission specified default CRC calculation
 ```
 
 Unless there is a specific interface with a specified CRC calculation,
-Applications must use the CFE_ES_DEFAULT_CRC type.
+Applications must use the CFE_MISSION_ES_DEFAULT_CRC type.
 
 #### 5.11 File System Functions
 
@@ -1215,7 +1215,7 @@ FILE: xx_app.c
 
 void XX_AppMain(void)
 {
-    uint32 RunStatus = CFE_ES_APP_RUN;
+    uint32 RunStatus = CFE_ES_RunStatus_APP_RUN;
     CFE_SB_MsgPtr_t MsgPtr;
     int32  Result = CFE_SUCCESS;
 
@@ -1238,7 +1238,7 @@ void XX_AppMain(void)
     */
     if (Result != CFE_SUCCESS)
     {
-        RunStatus = CFE_ES_APP_ERROR;
+        RunStatus = CFE_ES_RunStatus_APP_ERROR;
     }
 
     /*
@@ -1262,7 +1262,7 @@ void XX_AppMain(void)
         }
         else
         {
-            RunStatus = CFE_ES_APP_ERROR;
+            RunStatus = CFE_ES_RunStatus_APP_ERROR;
         }
     }
 

docs/src/cfe_api.dox

@@ -106,12 +106,6 @@
 	  <LI> #CFE_FS_WriteHeader - \copybrief CFE_FS_WriteHeader
 	  <LI> #CFE_FS_SetTimestamp - \copybrief CFE_FS_SetTimestamp
     </UL>
-    <LI> \ref CFEAPIFSCompress
-    <UL>
-	  <LI> #CFE_FS_IsGzFile - \copybrief CFE_FS_IsGzFile
-	  <LI> #CFE_FS_Decompress - \copybrief CFE_FS_Decompress
-          <LI> #CFE_FS_GetUncompressedFile - \copybrief CFE_FS_GetUncompressedFile
-    </UL>
     <LI> \ref CFEAPIFSUtil
     <UL>
 	  <LI> #CFE_FS_ExtractFilenameFromPath - \copybrief CFE_FS_ExtractFilenameFromPath
@@ -169,7 +163,6 @@
       <LI> #CFE_SB_GetTotalMsgLength - \copybrief CFE_SB_GetTotalMsgLength
       <LI> #CFE_SB_GetMsgTime - \copybrief CFE_SB_GetMsgTime
       <LI> #CFE_SB_GetCmdCode - \copybrief CFE_SB_GetCmdCode
-      <LI> #CFE_SB_GetLastSenderId - \copybrief CFE_SB_GetLastSenderId
       <LI> #CFE_SB_MessageStringGet - \copybrief CFE_SB_MessageStringGet
     </UL>
     <LI> \ref CFEAPISBChecksum
@@ -247,8 +240,6 @@
       <LI> #CFE_TIME_MET2SCTime - \copybrief CFE_TIME_MET2SCTime
       <LI> #CFE_TIME_Sub2MicroSecs - \copybrief CFE_TIME_Sub2MicroSecs
       <LI> #CFE_TIME_Micro2SubSecs - \copybrief CFE_TIME_Micro2SubSecs
-      <LI> #CFE_TIME_CFE2FSSeconds - \copybrief CFE_TIME_CFE2FSSeconds
-      <LI> #CFE_TIME_FS2CFESeconds - \copybrief CFE_TIME_FS2CFESeconds
     </UL>
     <LI> \ref CFEAPITIMEExternSource
     <UL>

docs/src/cfe_es.dox

@@ -166,10 +166,10 @@
 
   Immediately after the cFE completes its initialization, the ES Application first 
   looks for the volatile startup script. The location in the file system is defined 
-  by the cFE platform configuration parameter named #CFE_ES_VOLATILE_STARTUP_FILE. 
+  by the cFE platform configuration parameter named #CFE_PLATFORM_ES_VOLATILE_STARTUP_FILE. 
   This configuration parameter contains a path as well as a filename. If the file 
   is found, ES begins to startup the applications that are listed in the file. If 
-  ES does not find the file, it attempts to open the #CFE_ES_NONVOL_STARTUP_FILE.
+  ES does not find the file, it attempts to open the #CFE_PLATFORM_ES_NONVOL_STARTUP_FILE.
 
   If ES finds the volatile startup script, the attempt to open the nonvolatile startup 
   script is bypassed.
@@ -219,18 +219,18 @@
 
   The Reset Type is sent to the ground in the ES housekeeping packet and tells 
   how the current running version of the cFE was invoked. The possible Reset 
-  Types expected in the telemetry field are #CFE_ES_POWERON_RESET and 
-  #CFE_ES_PROCESSOR_RESET. There is a third Reset Type defined in the ES 
+  Types expected in the telemetry field are #CFE_PSP_RST_TYPE_POWERON and 
+  #CFE_PSP_RST_TYPE_PROCESSOR. There is a third Reset Type defined in the ES 
   code as #CFE_ES_APP_RESTART which applies only to restarting an individual 
   application and is covered in more detail in the section titled Application 
   and Child Task.
 
   The Reset Subtype is also sent in the ES housekeeping packet and gives more 
   detail about the type of reset that started the execution of the current 
   running version of the cFE. The possible Reset Subtypes are 
-  #CFE_ES_POWER_CYCLE, #CFE_ES_PUSH_BUTTON, #CFE_ES_HW_SPECIAL_COMMAND,
-  #CFE_ES_HW_WATCHDOG, #CFE_ES_RESET_COMMAND, #CFE_ES_EXCEPTION,
-  #CFE_ES_UNDEFINED_RESET, #CFE_ES_HWDEBUG_RESET, #CFE_ES_BANKSWITCH_RESET.
+  #CFE_PSP_RST_SUBTYPE_POWER_CYCLE, #CFE_PSP_RST_SUBTYPE_PUSH_BUTTON, #CFE_PSP_RST_SUBTYPE_HW_SPECIAL_COMMAND,
+  #CFE_PSP_RST_SUBTYPE_HW_WATCHDOG, #CFE_PSP_RST_SUBTYPE_RESET_COMMAND, #CFE_PSP_RST_SUBTYPE_EXCEPTION,
+  #CFE_PSP_RST_SUBTYPE_UNDEFINED_RESET, #CFE_PSP_RST_SUBTYPE_HWDEBUG_RESET, #CFE_PSP_RST_SUBTYPE_BANKSWITCH_RESET.
 
   Next: \ref cfeesugresetlog <BR>
   Prev: \ref cfeesugswreset <BR>
@@ -245,17 +245,17 @@
   command must be sent. This command will write the log to a binary file. 
   The path and filename may be specified in the command. If the filename 
   command field contains an empty string, the configuration parameter 
-  #CFE_ES_DEFAULT_ER_LOG_FILE is used to specify the path and filename.  
+  #CFE_PLATFORM_ES_DEFAULT_ER_LOG_FILE is used to specify the path and filename.  
   Use the ground system to get the file and display the contents.  There 
   is also a command to clear the ER log, #CFE_ES_CLEAR_ER_LOG_CC.
 
   The size of the ER log is defined by the platform configuration parameter 
-  #CFE_ES_ER_LOG_ENTRIES This log is preserved after a processor reset and 
+  #CFE_PLATFORM_ES_ER_LOG_ENTRIES This log is preserved after a processor reset and 
   held in the ES reset area.  
 
   A count of the number of entries in the log is present in the ES 
   housekeeping telemetry. This count can be used with the configuration 
-  parameter #CFE_ES_ER_LOG_ENTRIES to calculate the fullness of the log.
+  parameter #CFE_PLATFORM_ES_ER_LOG_ENTRIES to calculate the fullness of the log.
 
   The information contained in a single log entry is defined by the 
   structure CFE_ES_ERLog_t.
@@ -496,7 +496,7 @@
   collection. When the stop command is received, the ES task writes 
   all the data from the buffer to a file. The file can then be 
   imported to analysis tools for viewing. The size of the
-  buffer is configurable through the #CFE_ES_PERF_DATA_BUFFER_SIZE
+  buffer is configurable through the #CFE_PLATFORM_ES_PERF_DATA_BUFFER_SIZE
   platform configuration parameter.
 
   Additional information follows:<BR>
@@ -555,7 +555,7 @@
   The #CFE_ES_STOP_PERF_DATA_CC command is used to stop the data collection 
   process and write the buffer data to a file. The path and filename may be 
   specified in the command. If the filename command field contains an empty 
-  string, the configuration parameter #CFE_ES_DEFAULT_PERF_DUMP_FILENAME is 
+  string, the configuration parameter #CFE_PLATFORM_ES_DEFAULT_PERF_DUMP_FILENAME is 
   used to specify the path and filename.  The number of entries written to 
   the file is determined by the 'data count' variable, which is sent in the 
   ES housekeeping telemetry packet. To ensure cpu hogging does not occur 
@@ -734,7 +734,7 @@
 
   This command will cause Executive Services to extract pertinent statistics
   from the data used to manage the Memory Pool and telemeter them to the ground
-  in the \link #CFE_ES_PoolStatsTlm_t Memory Pool Statistics Telemetry Packet.
+  in the \link #CFE_ES_MemStatsTlm_t Memory Pool Statistics Telemetry Packet.
   \endlink
 
   In order to obtain the statistics associated with a memory pool, the operator
@@ -746,7 +746,7 @@
   Services (EVS) and Table Services (TBL).  Each of these cFE Core Applications
   report their memory pool handles in telemetry.
 
-  The \link #CFE_ES_PoolStatsTlm_t Memory Pool Statistics Telemetry Packet
+  The \link #CFE_ES_MemStatsTlm_t Memory Pool Statistics Telemetry Packet
   \endlink contains the following information:
 
   <UL>
@@ -785,12 +785,12 @@
   be sent. This command will write the log to a binary file. The path and
   filename may be specified in the command. If the filename command field
   contains an empty string, the configuration parameter
-  #CFE_ES_DEFAULT_SYSLOG_FILE is used to specify the path and filename.  Use the
+  #CFE_PLATFORM_ES_DEFAULT_SYSLOG_FILE is used to specify the path and filename.  Use the
   ground system to get the file and display the contents.  The
   #CFE_ES_CLEAR_SYSLOG_CC is used to clear the System log.
 
   The size of the System log is defined by the platform configuration parameter
-  #CFE_ES_SYSTEM_LOG_SIZE. This log is preserved after a processor reset and
+  #CFE_PLATFORM_ES_SYSTEM_LOG_SIZE. This log is preserved after a processor reset and
   held in the ES reset area.  
 
   A count of the number of entries in the log is present in the ES housekeeping

docs/src/cfe_evs.dox

@@ -142,7 +142,7 @@
   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 
   to affect multiple types within one command using a bit mask.  Note also that the 
-  configuration parameter #CFE_EVS_DEFAULT_TYPE_FLAG in the cfe_platform_cfg.h file 
+  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.  
 
   <CENTER><H2> Event Message Control - By Application </H2></CENTER>
@@ -170,7 +170,7 @@
   the events that it wants to register for filtering along with the 
   \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_EVS_MAX_EVENT_FILTERS in cfe_platform_cfg.h 
+  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 
   message is forwarded to the software bus, making it available in telemetry (see 
   \ref cfeevsugmsgfilter for a description on filtering).  Commands are available to 
@@ -340,7 +340,7 @@
      <LI> Active Flag - If equal to FALSE (0), all events from this Application are Filtered <BR>
      <LI> Event Count - Total number of events issued by this Application.  Note that this value
      stop incrementing at 65535. <BR>
-     <BR>The following information for each Filtered Event (up to #CFE_EVS_MAX_EVENT_FILTERS): <BR><BR>
+     <BR>The following information for each Filtered Event (up to #CFE_PLATFORM_EVS_MAX_EVENT_FILTERS): <BR><BR>
      <LI> Event ID - Event ID for event whose filter has been defined <BR>
      <LI> Mask - Binary Filter mask value (see \ref cfeevsugmsgfilter for an explanation) <BR>
      <LI> Count - Current number of times this Event ID has been issued by this Application <BR>

docs/src/cfe_glossary.dox

@@ -71,8 +71,8 @@
      <TR>
         <TD> \anchor cfeadg_eventtype Event Type
         <TD> A numeric literal used to identify the type of an Application event.
-             An event type may be #CFE_EVS_DEBUG, #CFE_EVS_INFORMATION, 
-             #CFE_EVS_ERROR, or #CFE_EVS_CRITICAL.
+             An event type may be #CFE_EVS_EventType_DEBUG, #CFE_EVS_EventType_INFORMATION, 
+             #CFE_EVS_EventType_ERROR, or #CFE_EVS_EventType_CRITICAL.
      <TR>
         <TD> \anchor cfeadg_eventmessage Event Message
         <TD> A data item used to notify the user and/or an external 

docs/src/cfe_sb.dox

@@ -127,7 +127,7 @@
   in the subscription is sometimes referred to as the destination of the message.
   There are a maximum number of destinations for a particular message. This
   value is specified by the platform configuration parameter
-  #CFE_SB_MAX_DEST_PER_PKT.
+  #CFE_PLATFORM_SB_MAX_DEST_PER_PKT.
 
   As subscriptions are received, the destinations are added to the head of a
   linked list. During the sending of a message, the list is traversed beginning
@@ -158,10 +158,10 @@
 
   The software bus statically allocates a block of memory for message buffers and
   subscription blocks. The size of this memory block is defined by the platform configuration
-  parameter #CFE_SB_BUF_MEMORY_BYTES. The memory is managed by the cFE ES memory
+  parameter #CFE_PLATFORM_SB_BUF_MEMORY_BYTES. The memory is managed by the cFE ES memory
   pool and is used only by the software bus. The ES memory pool allows an application to define
   the block sizes for the pool at compile time. These sizes are defined by the platform
-  configuration parameters prefixed with CFE_SB_MEM_BLOCK_SIZE (for example, #CFE_SB_MEM_BLOCK_SIZE_01).
+  configuration parameters prefixed with CFE_SB_MEM_BLOCK_SIZE (for example, #CFE_PLATFORM_SB_MEM_BLOCK_SIZE_01).
   It is recommended that a project tailor these values for the mission, based on the software
   bus packet sizes.
 
@@ -179,7 +179,7 @@
   The software bus provides a set of figures regarding memory capacity, current memory
   utilization and high water marks relevant to the SB memory pool. This information may be
   requested by sending the command to dump the SB statistics packet. In addition, the
-  current memory utilization value and the 'unmarked memory' value (#CFE_SB_BUF_MEMORY_BYTES
+  current memory utilization value and the 'unmarked memory' value (#CFE_PLATFORM_SB_BUF_MEMORY_BYTES
   minus peak memory in use)  are sent in software bus housekeeping telemetry. The unmarked
   memory value  should be monitored regularly to ensure that the value (in bytes) does not
   continue to decline or approach zero. If this value were to approach zero, there is a
@@ -336,7 +336,7 @@
   If this error occurs during nominal conditions, it could be an indication that the
   'message limit' is not set correctly. The message limit is given at the time of the
   subscription and given as a parameter in the subscribe API. With the #CFE_SB_Subscribe
-  API, the SB uses a default message limit value specified by #CFE_SB_DEFAULT_MSG_LIMIT.
+  API, the SB uses a default message limit value specified by #CFE_PLATFORM_SB_DEFAULT_MSG_LIMIT.
   This constant is currently set to a value of four. If the default value is insufficient,
   the message limit value can be specified in the #CFE_SB_SubscribeEx API.
 
@@ -478,7 +478,7 @@
 
   The simplest way to prevent this behavior is to ensure that there is margin when sizing the
   SB memory pool. To check the margin, monitor the "Peak Memory in Use" vs. the configuration
-  parameter #CFE_SB_BUF_MEMORY_BYTES which indicates the amount allocated.
+  parameter #CFE_PLATFORM_SB_BUF_MEMORY_BYTES which indicates the amount allocated.
 
   Next: \ref cfesbugfaq <BR>
   Prev: \ref cfesbugqos <BR>

docs/src/cfe_tbl.dox

@@ -162,7 +162,7 @@
   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
-  time is specified by a TBL Services configuration parameter (#CFE_TBL_MAX_SIMULTANEOUS_LOADS) found
+  time is specified by a TBL Services configuration parameter (#CFE_PLATFORM_TBL_MAX_SIMULTANEOUS_LOADS) found
   in the cfe_platform_cfg.h file associated with the processor in question.  This parameter identifies
   the number of shared table buffers that are available.
 
@@ -194,7 +194,7 @@
   Applications which have unusually large tables may decide to conserve memory resources by making
   them double buffered.  This is because the shared buffers used by single buffered tables must be
   sized to match the largest table.  If there is one table that is unusually large, there is little
-  reason to allocate up to #CFE_TBL_MAX_SIMULTANEOUS_LOADS number of buffers that size.  A double
+  reason to allocate up to #CFE_PLATFORM_TBL_MAX_SIMULTANEOUS_LOADS number of buffers that size.  A double
   buffered table will only allocate ONE extra buffer of that size.
 
   Performance minded Applications that are required to perform processing with tight timing deadlines
@@ -324,7 +324,7 @@
   Table Services produces two different telemetry packets.  The first packet, referred to as the Table
   Services Housekeeping Packet, is routinely produced by Table Services upon receipt of the Housekeeping
   Request message that is typically sent to all Applications by an on board scheduler.  The contents and
-  format of this packet are described in detail at #CFE_TBL_HkPacket_t.
+  format of this packet are described in detail at #CFE_TBL_HousekeepingTlm_t.
 
   Next: \ref cfetblugprocreset <BR>
   Prev: \ref cfetblugregistry <BR>