From 198ae7dd0695750d155762d7bbaf21f0400470dc Mon Sep 17 00:00:00 2001 From: Jacob Hageman Date: Wed, 16 Mar 2022 06:51:13 -0600 Subject: [PATCH 1/3] Fix #2064, Use osal-common.doxygen to resolve OSAL Doxygen refs --- cmake/cfe-usersguide.doxyfile.in | 8 +++++--- cmake/mission-detaildesign.doxyfile.in | 1 - cmake/mission_build.cmake | 2 -- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/cmake/cfe-usersguide.doxyfile.in b/cmake/cfe-usersguide.doxyfile.in index eb950b381..fa6466dd3 100644 --- a/cmake/cfe-usersguide.doxyfile.in +++ b/cmake/cfe-usersguide.doxyfile.in @@ -5,14 +5,16 @@ # Allow overrides @INCLUDE_PATH = @MISSION_SOURCE_DIR@ -# Common configuration and default settings +# Common setup @INCLUDE = @MISSION_BINARY_DIR@/docs/cfe-common.doxyfile -@INCLUDE = @MISSION_SOURCE_DIR@/osal/docs/src/default-settings.doxyfile + +# Include osal to resolve references and provide default settings +@INCLUDE = @MISSION_BINARY_DIR@/docs/osal-common.doxyfile # Document specific settings PROJECT_NAME = "Core Flight Executive Users Guide" OUTPUT_DIRECTORY = @CMAKE_BINARY_DIR@/docs/users_guide -WARN_LOGFILE = @CMAKE_BINARY_DIR@/docs/cfe-usersguide-warnings.log +WARN_LOGFILE = @CMAKE_BINARY_DIR@/docs/users_guide/cfe-usersguide-warnings.log # For purposes of the user guide, reference the "stock" mission configuration # Although missions may override these files, for the users guide we are mainly diff --git a/cmake/mission-detaildesign.doxyfile.in b/cmake/mission-detaildesign.doxyfile.in index 9085fcfe9..f6d40029f 100644 --- a/cmake/mission-detaildesign.doxyfile.in +++ b/cmake/mission-detaildesign.doxyfile.in @@ -7,7 +7,6 @@ # Common configuration and default settings @INCLUDE = @MISSION_BINARY_DIR@/docs/cfe-common.doxyfile -@INCLUDE = @MISSION_SOURCE_DIR@/osal/docs/src/default-settings.doxyfile # Example detailed design setup PROJECT_NAME = "@MISSION_NAME@" diff --git a/cmake/mission_build.cmake b/cmake/mission_build.cmake index 13da95f84..8d96f8046 100644 --- a/cmake/mission_build.cmake +++ b/cmake/mission_build.cmake @@ -290,7 +290,6 @@ function(prepare) # NOTE: the userguide is built against the headers of the default core apps. Even if # an alternate version of the module is in use, it should adhere to the same interface. set(SUBMODULE_HEADER_PATHS - "${osal_MISSION_DIR}/src/os/inc/*.h" "${psp_MISSION_DIR}/psp/fsw/inc/*.h" ) foreach(MODULE core_api ${MISSION_CORE_MODULES}) @@ -298,7 +297,6 @@ function(prepare) endforeach() file(GLOB MISSION_USERGUIDE_HEADERFILES ${SUBMODULE_HEADER_PATHS} - "${CMAKE_BINARY_DIR}/docs/osconfig-example.h" ) string(REPLACE ";" " \\\n" MISSION_USERGUIDE_HEADERFILES "${MISSION_USERGUIDE_HEADERFILES}") From 0a9e232a7041ec424a6fb54d6e7b801a731cda10 Mon Sep 17 00:00:00 2001 From: Jacob Hageman Date: Wed, 16 Mar 2022 11:10:57 -0600 Subject: [PATCH 2/3] Fix #2064, Update doxygen warning file logic in workflow --- .github/workflows/build-documentation.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/build-documentation.yml b/.github/workflows/build-documentation.yml index 86e646a16..a2752791b 100644 --- a/.github/workflows/build-documentation.yml +++ b/.github/workflows/build-documentation.yml @@ -122,7 +122,7 @@ jobs: - name: Build Usersguide run: | make usersguide > make_usersguide_stdout.txt 2> make_usersguide_stderr.txt - mv build/docs/cfe-usersguide-warnings.log usersguide_warnings.log + mv build/docs/users_guide/cfe-usersguide-warnings.log cfe-usersguide-warnings.log - name: Archive Users Guide Build Logs uses: actions/upload-artifact@v2 @@ -131,7 +131,7 @@ jobs: path: | make_usersguide_stdout.txt make_usersguide_stderr.txt - usersguide_warnings.log + cfe-usersguide-warnings.log - name: Error Check run: | @@ -142,7 +142,7 @@ jobs: - name: Warning Check run: | - if [[ -s usersguide_warnings.log ]]; then - cat usersguide_warnings.log + if [[ -s cfe-usersguide-warnings.log ]]; then + cat cfe-usersguide-warnings.log exit -1 fi From e5be0612ad6bf9db09ddf640306a65292abce2d5 Mon Sep 17 00:00:00 2001 From: "Gerardo E. Cruz-Ortiz" <59618057+astrogeco@users.noreply.github.com> Date: Wed, 16 Mar 2022 17:34:51 -0400 Subject: [PATCH 3/3] Bump to v7.0.0-rc4+dev87 IC: Caelum-rc4+dev6, nasa/cFS#443 - Reverts development version identifier to 99 for revision number --- README.md | 6 ++++++ docs/src/cfs_versions.dox | 2 +- modules/core_api/fsw/inc/cfe_version.h | 8 ++++---- 3 files changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 34583defe..583aba37a 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,12 @@ The detailed cFE user's guide can be viewed at and ### Development Build: v7.0.0-rc4+dev80 - Missing SB include for v2 msgid diff --git a/docs/src/cfs_versions.dox b/docs/src/cfs_versions.dox index 8e3c871fb..5a21cf583 100644 --- a/docs/src/cfs_versions.dox +++ b/docs/src/cfs_versions.dox @@ -22,7 +22,7 @@ bug fixes or major documentation updates. The Revision number may also be updated if there are other changes contained within a release that make it desirable for applications to distinguish one release from another. - WARNING: The revision number is set to the number 99 in development builds. To distinguish between development + WARNING: The revision number is set to the number 0xFF in development builds. To distinguish between development builds refer to the BUILD_NUMBER and BUILD_BASELINE detailed in the section "Identifying Development Builds". The Mission Version number is set to zero in all official releases, and is reserved for the mission use. diff --git a/modules/core_api/fsw/inc/cfe_version.h b/modules/core_api/fsw/inc/cfe_version.h index 77d468f48..4fb0316ff 100644 --- a/modules/core_api/fsw/inc/cfe_version.h +++ b/modules/core_api/fsw/inc/cfe_version.h @@ -34,15 +34,15 @@ /* Version Macro Definitions updated for official releases only */ #define CFE_MAJOR_VERSION 6 /**< @brief Major release version (Former for Revision == 99) */ #define CFE_MINOR_VERSION 7 /**< @brief Minor release version (Former for Revision == 99) */ -#define CFE_REVISION 0 /*!< @brief ONLY APPLY for OFFICIAL releases. Revision number. */ +#define CFE_REVISION \ + 99 /*!< @brief * Set to 0 on OFFICIAL releases, and set to 99 on development versions. Revision number. */ /*! * @brief Mission revision. * - * Set to 0 on OFFICIAL releases, and set to 255 (0xFF) on development versions. - * Values 1-254 are reserved for mission use to denote patches/customizations as needed. + * Reserved for mission use to denote patches/customizations as needed. */ -#define CFE_MISSION_REV 0xFF +#define CFE_MISSION_REV 0 #define CFE_STR_HELPER(x) #x /**< @brief Convert argument to string */ #define CFE_STR(x) CFE_STR_HELPER(x) /**< @brief Expand macro before conversion */