Skip to content

Commit

Permalink
Add description for build name and build number.
Browse files Browse the repository at this point in the history
Add build name and number #define

Apply clang-format
  • Loading branch information
astrogeco committed Jul 6, 2020
1 parent cea5239 commit f8c0fea
Showing 1 changed file with 23 additions and 8 deletions.
31 changes: 23 additions & 8 deletions fsw/cfe-core/src/inc/cfe_version.h
Original file line number Diff line number Diff line change
Expand Up @@ -65,20 +65,31 @@
* The minor number may increment when there have been no augmentations to the API, if changes are as significant as
* additions to the public API.
*
* The revision numbers may update in implementations where no actual implementation-specific code has changed, if
* The revision numbers may increment in implementations where no actual implementation-specific code has changed, if
* there are other changes within the release with similar significance.
*
* <H2> How and Where Defined </H2>
*
* The Major, Minor, and Revision components of the version are provided as simple macros defined in the cfe_version.h
* header file as part of the API definition; these macros must expand to simple integer values, so that they can be used
* in simple if directives by the macro preprocessor.
* header file as part of the API definition; these macros must expand to simple integer values, so that they can be
* used in simple if directives by the macro preprocessor.
*
* The Mission Version is provided as a simple macro defined in the cfe_platform_cfg.h header file. As delivered in
* official releases, these macros must expand to simple integer values, so that they can be used in simple macro
* preprocessor conditions, but delivered code should not prevent a mission from, for example, deciding that the Mission
* Version is actually a text string.
*
* <H2> Identification of development builds </H2>
*
* In order to distinguish between development versions, we provide a BUILD_NAME and a BUILD_NUMBER.
*
* The BUILDNAME is a unifying monicker that indicates compatibility across the core Flight System's propduct suite. The
* build name is a star or constellation name and changes once per official release. Subsequent build names starts with
* the next letter in the 24-character alphabet. In between official releases, the BUILDNAME will be held constant.
*
* The BUILDNUMBER reflects the number of commits since the last official release for each particular component. This
* integer monotonically increases for a given BUILDNAME. When a new BUILDNAME is applied, the BUILDNUMBER resets to
* zero.
*/

#ifndef _cfe_version_
Expand All @@ -91,13 +102,17 @@
*/
#include <target_config.h>


/*
** Macro Definitions
*/
#define CFE_MAJOR_VERSION 6
#define CFE_MINOR_VERSION 7
#define CFE_REVISION 21
#define CFE_MAJOR_VERSION 6
#define CFE_MINOR_VERSION 7
#define CFE_REVISION 21

/*
** Development build identifiers
*/
#define CFE_BUILD_NAME BOOTES
#define CFE_BUILD_NUMBER 1

#endif /* _cfe_version_ */
#endif /* _cfe_version_ */

0 comments on commit f8c0fea

Please sign in to comment.