Merge pul request #170 from astrogeco/standardize-version.h

HOTFIX #163, Standardize versioning information
nasa · Mar 25, 2022 · dfe8c50 · dfe8c50
2 parents f8da172 + c259155
commit dfe8c50
Showing 1 changed file with 9 additions and 7 deletions.
diff --git a/fsw/src/sample_app_version.h b/fsw/src/sample_app_version.h
@@ -31,17 +31,19 @@
 #define SAMPLE_APP_BUILD_BASELINE \
     "v1.3.0-rc4" /*!< Development Build: git tag that is the base for the current development */
 
-/* Version Macro Definitions */
-
-#define SAMPLE_APP_MAJOR_VERSION 1 /*!< @brief ONLY APPLY for OFFICIAL releases. Major version number. */
-#define SAMPLE_APP_MINOR_VERSION 1 /*!< @brief ONLY APPLY for OFFICIAL releases. Minor version number. */
-#define SAMPLE_APP_REVISION      0 /*!< @brief ONLY APPLY for OFFICIAL releases. Revision version number. */
+/*
+ * Version Macros, see \ref cfsversions for definitions.
+ */
+#define SAMPLE_APP_MAJOR_VERSION 1  /*!< @brief Major version number. */
+#define SAMPLE_APP_MINOR_VERSION 1  /*!< @brief Minor version number. */
+#define SAMPLE_APP_REVISION      99 /**< @brief Revision version number. Value of 99 indicates a development version.*/
 
 /*!
  * @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.
+ * Values 1-254 are 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 SAMPLE_APP_MISSION_REV 0xFF