Skip to content

Commit

Permalink
Set CFE_REVISION = 99 and CFE_MISSION_REV to 0xff
Browse files Browse the repository at this point in the history
Add link to cfs_versions.dox for documentation
Add note on CFE_MISSION_REV = 0xFF situation referring to nasa/cFS#440
  • Loading branch information
astrogeco committed Mar 24, 2022
1 parent a39b0a6 commit 697ad0a
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
12 changes: 6 additions & 6 deletions docs/src/cfs_versions.dox
Original file line number Diff line number Diff line change
Expand Up @@ -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 0xFF in development builds. To distinguish between development
WARNING: The revision number is set to the number 99 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.
Expand All @@ -42,7 +42,7 @@

The BUILD_NUMBER reflects the number of commits since the BUILD_BASELINE, a baseline git tag, for each particular
component. The BUILD_NUMBER integer monotonically increases for a given baseline. The BUILD_BASELINE
identifies the current development cycle and is a git tag with format vX.Y.Z. The Codename used in the version
identifies the current development cycle and is a git tag with format vMAJOR.MINOR.REVISION. The Codename used in the version
string also refers to the current development cycle. When a new baseline tag and codename are created, the
BUILD_NUMBER resets to zero and begins increasing from a new baseline.

Expand All @@ -53,15 +53,15 @@
name; for example, osal uses OS_, psp uses CFE_PSP_IMPL, and so on.

Suggested pattern for development:
- XXX_SRC_VERSION: REFERENCE_GIT_TAG"+dev"BUILD_NUMBER
- CFSCOMPONENT_SRC_VERSION: REFERENCE_GIT_TAG"+dev"BUILD_NUMBER
- Example: "v6.8.0-rc1+dev123"
- XXX_VERSION_STRING: "XXX DEVELOPMENT BUILD "XXX_SRC_VERSION" (Codename: YYY), Last Official Release: ZZZ"
- CFSCOMPONENT_VERSION_STRING: "CFSCOMPONENT DEVELOPMENT BUILD "CFSCOMPONENT_SRC_VERSION" (Codename: CFSCONSTELLATION), Last Official Release: MAJOR.MINOR.REVISION"
- Example: "cFE DEVELOPMENT BUILD v6.8.0-rc1+dev123 (Codename: Bootes), Last Official Release: cfe v6.7.0"

Suggested pattern for official releases:
- XXX_SRC_VERSION: OFFICIAL_GIT_TAG
- CFSCOMPONENT_SRC_VERSION: OFFICIAL_GIT_TAG
- Example: "v7.0.0"
- XXX_VERSION_STRING: "XXX OFFICIAL RELEASE "XXX_SRC_VERSION" (Codename: YYY)"
- COMPONENT_VERSION_STRING: "CFSCOMPONENT OFFICIAL RELEASE "CFSCOMPONENT_SRC_VERSION" (Codename: CFSCONSTELLATION)"
- Example: "cFE OFFICIAL RELEASE v7.0.0 (Codename: Caelum)"

**/
14 changes: 7 additions & 7 deletions modules/core_api/fsw/inc/cfe_version.h
Original file line number Diff line number Diff line change
Expand Up @@ -28,21 +28,21 @@
#define CFE_VERSION_H

/* Development Build Macro Definitions */
#define CFE_BUILD_NUMBER 80 /**< @brief Development: Number of development commits since baseline */
#define CFE_BUILD_NUMBER 80 /**< @brief Development: Number of development git commits since CFE_BUILD_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 */
#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 \
99 /*!< @brief * Set to 0 on OFFICIAL releases, and set to 99 on development versions. Revision number. */
/* See \ref cfsversions for definitions */
#define CFE_MAJOR_VERSION 6 /**< @brief Major version number */
#define CFE_MINOR_VERSION 7 /**< @brief Minor version number */
#define CFE_REVISION 99 /**< @brief Revision version number */

/*!
* @brief Mission revision.
*
* Reserved for mission use to denote patches/customizations as needed.
* NOTE: Reserving 0 and 0xFF for cFS open-source development use pending resolution of nasa/cFS#440"
*/
#define CFE_MISSION_REV 0
#define CFE_MISSION_REV 0xFF

#define CFE_STR_HELPER(x) #x /**< @brief Convert argument to string */
#define CFE_STR(x) CFE_STR_HELPER(x) /**< @brief Expand macro before conversion */
Expand Down

0 comments on commit 697ad0a

Please sign in to comment.