From f166a0a5a5c70bcfb91a5b67a9d518707f8088f1 Mon Sep 17 00:00:00 2001 From: Jacob Hageman Date: Thu, 10 Feb 2022 07:30:34 -0700 Subject: [PATCH 1/5] Fix #2047, Add CFE_ES_CreateChildTask default handler --- .../core_api/ut-stubs/src/cfe_es_handlers.c | 34 +++++++++++++++++++ modules/core_api/ut-stubs/src/cfe_es_stubs.c | 3 +- 2 files changed, 36 insertions(+), 1 deletion(-) 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 08cc6a17e..956ae12a6 100644 --- a/modules/core_api/ut-stubs/src/cfe_es_handlers.c +++ b/modules/core_api/ut-stubs/src/cfe_es_handlers.c @@ -116,6 +116,40 @@ static const cpuaddr UT_ESPOOL_ALIGN_MASK = ((cpuaddr) & ((struct UT_AlignTest * ** Functions */ +/*------------------------------------------------------------ + * + * Default handler for CFE_ES_CreateChildTask coverage stub function + * + *------------------------------------------------------------*/ +void UT_DefaultHandler_CFE_ES_CreateChildTask(void *UserObj, UT_EntryKey_t FuncKey, const UT_StubContext_t *Context) +{ + CFE_ES_TaskId_t *TaskIdPtr = UT_Hook_GetArgValueByName(Context, "TaskIdPtr", CFE_ES_TaskId_t *); + int32 status; + void * IdBuff; + size_t BuffSize; + size_t Position; + + UT_Stub_GetInt32StatusCode(Context, &status); + + if (status >= 0) + { + UT_GetDataBuffer(UT_KEY(CFE_ES_GetAppID), &IdBuff, &BuffSize, &Position); + if (IdBuff != NULL && BuffSize == sizeof(*TaskIdPtr)) + { + memcpy(TaskIdPtr, IdBuff, sizeof(*TaskIdPtr)); + } + else + { + *TaskIdPtr = CFE_UT_ES_DEFAULT_TASKID; + } + } + + if (status < 0) + { + *TaskIdPtr = CFE_ES_TASKID_UNDEFINED; + } +} + /*------------------------------------------------------------ * * Default handler for CFE_ES_GetAppID coverage stub function diff --git a/modules/core_api/ut-stubs/src/cfe_es_stubs.c b/modules/core_api/ut-stubs/src/cfe_es_stubs.c index 5a1a75c2c..bfdb92d2c 100644 --- a/modules/core_api/ut-stubs/src/cfe_es_stubs.c +++ b/modules/core_api/ut-stubs/src/cfe_es_stubs.c @@ -31,6 +31,7 @@ void UT_DefaultHandler_CFE_ES_AppID_ToIndex(void *, UT_EntryKey_t, const UT_StubContext_t *); void UT_DefaultHandler_CFE_ES_CopyToCDS(void *, UT_EntryKey_t, const UT_StubContext_t *); +void UT_DefaultHandler_CFE_ES_CreateChildTask(void *, UT_EntryKey_t, const UT_StubContext_t *); void UT_DefaultHandler_CFE_ES_ExitApp(void *, UT_EntryKey_t, const UT_StubContext_t *); void UT_DefaultHandler_CFE_ES_GetAppID(void *, UT_EntryKey_t, const UT_StubContext_t *); void UT_DefaultHandler_CFE_ES_GetAppIDByName(void *, UT_EntryKey_t, const UT_StubContext_t *); @@ -146,7 +147,7 @@ CFE_Status_t CFE_ES_CreateChildTask(CFE_ES_TaskId_t *TaskIdPtr, const char *Task UT_GenStub_AddParam(CFE_ES_CreateChildTask, CFE_ES_TaskPriority_Atom_t, Priority); UT_GenStub_AddParam(CFE_ES_CreateChildTask, uint32, Flags); - UT_GenStub_Execute(CFE_ES_CreateChildTask, Basic, NULL); + UT_GenStub_Execute(CFE_ES_CreateChildTask, Basic, UT_DefaultHandler_CFE_ES_CreateChildTask); return UT_GenStub_GetReturnValue(CFE_ES_CreateChildTask, CFE_Status_t); } From 48bb886e199906590fc6c2224ebae34850e57725 Mon Sep 17 00:00:00 2001 From: Jacob Hageman Date: Thu, 17 Feb 2022 14:22:47 -0700 Subject: [PATCH 2/5] Fix #2049, Remove explicit filename doxygen comments --- cmake/target/src/target_config.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmake/target/src/target_config.c b/cmake/target/src/target_config.c index ac974c3ca..8b7e0d52c 100644 --- a/cmake/target/src/target_config.c +++ b/cmake/target/src/target_config.c @@ -19,7 +19,7 @@ */ /** - * \file target_config.c + * \file * * Created on: Dec 3, 2013 * Created by: joseph.p.hickey@nasa.gov From 30a4c4e835712955f6776a207678941950ac0a08 Mon Sep 17 00:00:00 2001 From: Jacob Hageman Date: Thu, 17 Feb 2022 16:12:43 -0700 Subject: [PATCH 3/5] Fix #2051, Resolve doxygen doc warnings and enforce in CI --- .github/workflows/build-documentation.yml | 9 +++++++++ cmake/cfe-common.doxyfile.in | 4 ++++ modules/sb/fsw/src/cfe_sb_priv.h | 6 +++--- modules/tbl/fsw/src/cfe_tbl_task.h | 2 +- 4 files changed, 17 insertions(+), 4 deletions(-) diff --git a/.github/workflows/build-documentation.yml b/.github/workflows/build-documentation.yml index 717c2e41d..86e646a16 100644 --- a/.github/workflows/build-documentation.yml +++ b/.github/workflows/build-documentation.yml @@ -60,6 +60,7 @@ jobs: - name: Build Docs run: | make doc > make_doc_stdout.txt 2> make_doc_stderr.txt + mv build/docs/detaildesign-warnings.log detaildesign-warnings.log # Upload documentation logs as artifacts - name: Archive Documentation Build Logs @@ -69,6 +70,7 @@ jobs: path: | make_doc_stdout.txt make_doc_stderr.txt + detaildesign-warnings.log - name: Error Check run: | @@ -77,6 +79,13 @@ jobs: exit -1 fi + - name: Warning Check + run: | + if [[ -s detaildesign-warnings.log ]]; then + cat detaildesign-warnings.log + exit -1 + fi + build-usersguide: #Continue if check-for-duplicates found no duplicates. Always runs for pull-requests. needs: check-for-duplicates diff --git a/cmake/cfe-common.doxyfile.in b/cmake/cfe-common.doxyfile.in index 68944bb60..87294c067 100644 --- a/cmake/cfe-common.doxyfile.in +++ b/cmake/cfe-common.doxyfile.in @@ -80,6 +80,10 @@ EXCLUDE_PATTERNS += "*/ut-stubs/*" EXCLUDE_PATTERNS += "*/ut-coverage/*" EXCLUDE_PATTERNS += "*/unit-test*/*" +# Exclude contributing guides and readme's since they stand alone as repo documentation +EXCLUDE_PATTERNS += "*/CONTRIBUTING.md" +EXCLUDE_PATTERNS += "*/README.md" + #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- diff --git a/modules/sb/fsw/src/cfe_sb_priv.h b/modules/sb/fsw/src/cfe_sb_priv.h index f46669726..5c19c72f4 100644 --- a/modules/sb/fsw/src/cfe_sb_priv.h +++ b/modules/sb/fsw/src/cfe_sb_priv.h @@ -693,7 +693,7 @@ int32 CFE_SB_ZeroCopyBufferValidate(CFE_SB_Buffer_t *BufPtr, CFE_SB_BufferD_t ** * \note Assumes destination pointer is valid * * \param[in] RouteId The route ID to add destination node to - * \param[in] DestPtr Pointer to the destination to add + * \param[in] NewNode Pointer to the destination to add */ int32 CFE_SB_AddDestNode(CFE_SBR_RouteId_t RouteId, CFE_SB_DestinationD_t *NewNode); @@ -705,8 +705,8 @@ int32 CFE_SB_AddDestNode(CFE_SBR_RouteId_t RouteId, CFE_SB_DestinationD_t *NewNo * * \note Assumes destination pointer is valid and in route * - * \param[in] RouteId The route ID to remove destination node from - * \param[in] DestPtr Pointer to the destination to remove + * \param[in] RouteId The route ID to remove destination node from + * \param[in] NodeToRemove Pointer to the destination to remove */ void CFE_SB_RemoveDestNode(CFE_SBR_RouteId_t RouteId, CFE_SB_DestinationD_t *NodeToRemove); diff --git a/modules/tbl/fsw/src/cfe_tbl_task.h b/modules/tbl/fsw/src/cfe_tbl_task.h index ed0fb49ea..6e40ba10e 100644 --- a/modules/tbl/fsw/src/cfe_tbl_task.h +++ b/modules/tbl/fsw/src/cfe_tbl_task.h @@ -402,7 +402,7 @@ int32 CFE_TBL_TaskInit(void); ** \par Assumptions, External Events, and Notes: ** None ** -** \param[in] MessagePtr a pointer to the message received from the command pipe +** \param[in] SBBufPtr Pointer to the message received from the command pipe ** */ void CFE_TBL_TaskPipe(CFE_SB_Buffer_t *SBBufPtr); From d40525390e6e509a4d2094d8b0601718285ee018 Mon Sep 17 00:00:00 2001 From: Jacob Hageman Date: Wed, 23 Feb 2022 07:54:19 -0700 Subject: [PATCH 4/5] Fix #2054, Missing SB include for v2 msgid --- modules/msg/fsw/src/cfe_msg_msgid_v2.c | 1 + 1 file changed, 1 insertion(+) diff --git a/modules/msg/fsw/src/cfe_msg_msgid_v2.c b/modules/msg/fsw/src/cfe_msg_msgid_v2.c index c3093dca5..67b6f4f21 100644 --- a/modules/msg/fsw/src/cfe_msg_msgid_v2.c +++ b/modules/msg/fsw/src/cfe_msg_msgid_v2.c @@ -40,6 +40,7 @@ #include "cfe_msg.h" #include "cfe_msg_priv.h" #include "cfe_error.h" +#include "cfe_sb.h" #include "cfe_platform_cfg.h" /* cFS MsgId definitions */ From e48c04920ec39bc8de6d2e6ad514b65ba04b1edc Mon Sep 17 00:00:00 2001 From: "Gerardo E. Cruz-Ortiz" <59618057+astrogeco@users.noreply.github.com> Date: Fri, 25 Feb 2022 12:18:16 -0500 Subject: [PATCH 5/5] Bump to v7.0.0-rc4+dev80 Part of IC:Caelum+dev4, nasa/cFS#432 **Includes** PR #2056 - Missing SB include for v2 msgid PR #2052 - Resolve doxygen doc warnings and enforce in CI PR #2050 - Remove explicit filename doxygen comments PR #2048 - Add CFE_ES_CreateChildTask default handler --- README.md | 8 ++++++++ modules/core_api/fsw/inc/cfe_version.h | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e5218e484..34583defe 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,14 @@ The detailed cFE user's guide can be viewed at and + ### Development Build: v7.0.0-rc4+dev70 - Improve CFE_SB_IsValidMsgId handler diff --git a/modules/core_api/fsw/inc/cfe_version.h b/modules/core_api/fsw/inc/cfe_version.h index 7d127dd50..77d468f48 100644 --- a/modules/core_api/fsw/inc/cfe_version.h +++ b/modules/core_api/fsw/inc/cfe_version.h @@ -28,7 +28,7 @@ #define CFE_VERSION_H /* Development Build Macro Definitions */ -#define CFE_BUILD_NUMBER 70 /**< @brief Development: Number of development commits since baseline */ +#define CFE_BUILD_NUMBER 80 /**< @brief Development: Number of development commits since baseline */ #define CFE_BUILD_BASELINE "v7.0.0-rc4" /**< @brief Development: Reference git tag for build number */ /* Version Macro Definitions updated for official releases only */