From d47a869f8c5b1adea37a42e5ebdaf51458b25ff7 Mon Sep 17 00:00:00 2001 From: Joseph Hickey Date: Tue, 8 Sep 2020 12:19:24 -0400 Subject: [PATCH] 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 | 2 +- docs/cFE Application Developers Guide.md | 16 ++--- docs/src/cfe_api.dox | 9 --- docs/src/cfe_es.dox | 32 +++++----- docs/src/cfe_evs.dox | 6 +- docs/src/cfe_glossary.dox | 4 +- docs/src/cfe_sb.dox | 12 ++-- docs/src/cfe_tbl.dox | 6 +- docs/src/cfe_time.dox | 60 +++++++++---------- docs/src/mnem_maps/cfe_evs_tlm_mnem_map | 12 ++-- docs/src/mnem_maps/cfe_sb_tlm_mnem_map | 12 ++-- fsw/cfe-core/eds/cfe_sb.xml | 18 +++--- fsw/cfe-core/eds/cfe_time.xml | 4 +- fsw/cfe-core/src/es/cfe_es_api.c | 12 ++-- fsw/cfe-core/src/es/cfe_es_global.h | 1 + fsw/cfe-core/src/es/cfe_es_log.h | 2 +- fsw/cfe-core/src/es/cfe_es_start.c | 6 +- fsw/cfe-core/src/inc/cfe_es.h | 14 ++--- fsw/cfe-core/src/inc/cfe_es_events.h | 30 ---------- fsw/cfe-core/src/inc/cfe_fs_extern_typedefs.h | 3 +- fsw/cfe-core/src/inc/cfe_sb_msg.h | 2 +- fsw/cfe-core/src/sb/cfe_sb_msg_id_util.c | 4 +- 22 files changed, 113 insertions(+), 154 deletions(-) diff --git a/cmake/sample_defs/cpu1_platform_cfg.h b/cmake/sample_defs/cpu1_platform_cfg.h index 05097082c..7e434f100 100644 --- a/cmake/sample_defs/cpu1_platform_cfg.h +++ b/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 diff --git a/docs/cFE Application Developers Guide.md b/docs/cFE Application Developers Guide.md index 3b34e230b..32f05ebfb 100644 --- a/docs/cFE Application Developers Guide.md +++ b/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; } } diff --git a/docs/src/cfe_api.dox b/docs/src/cfe_api.dox index 7a5113cb7..000e7c982 100644 --- a/docs/src/cfe_api.dox +++ b/docs/src/cfe_api.dox @@ -106,12 +106,6 @@
  • #CFE_FS_WriteHeader - \copybrief CFE_FS_WriteHeader
  • #CFE_FS_SetTimestamp - \copybrief CFE_FS_SetTimestamp -
  • \ref CFEAPIFSCompress -
  • \ref CFEAPIFSUtil
  • \ref CFEAPISBChecksum @@ -247,8 +240,6 @@
  • #CFE_TIME_MET2SCTime - \copybrief CFE_TIME_MET2SCTime
  • #CFE_TIME_Sub2MicroSecs - \copybrief CFE_TIME_Sub2MicroSecs
  • #CFE_TIME_Micro2SubSecs - \copybrief CFE_TIME_Micro2SubSecs -
  • #CFE_TIME_CFE2FSSeconds - \copybrief CFE_TIME_CFE2FSSeconds -
  • #CFE_TIME_FS2CFESeconds - \copybrief CFE_TIME_FS2CFESeconds
  • \ref CFEAPITIMEExternSource