Skip to content

Commit

Permalink
Close nasa#4 and nasa#21, add version.h with buildnumber
Browse files Browse the repository at this point in the history
Create version.h file and include it in cfe_ts_crc.c
Create macros for version information
Add version report to "help command" response
Update readme
  • Loading branch information
astrogeco committed Aug 10, 2020
1 parent 1b82c55 commit 914ad58
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ This lab application is a ground utility to generate binary table CRCs for cFS.

## Version Notes

### Development Build: 1.1.0+dev7

- Create a version header file
- Report version when responding to `-help` command
- See <https://github.com/nasa/tblCRCTool/pull/22>

### Development Build: 1.1.1

- Apply Code Style
Expand All @@ -31,4 +37,3 @@ This ground utility was developed for a specific mission/configuration, and may
For best results, submit issues:questions or issues:help wanted requests at https://github.com/nasa/cFS.

Official cFS page: https://cfs.gsfc.nasa.gov

2 changes: 2 additions & 0 deletions cfe_ts_crc.c
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@
#include <stdlib.h>
#include <unistd.h>

#include "cfe_ts_crc_version.h"

#define CFE_ES_CRC_8 1 /**< \brief CRC ( 8 bit additive - returns 32 bit total) (Currently not implemented) */
#define CFE_ES_CRC_16 2 /**< \brief CRC (16 bit additive - returns 32 bit total) */
#define CFE_ES_CRC_32 3 /**< \brief CRC (32 bit additive - returns 32 bit total) (Currently not implemented) */
Expand Down
67 changes: 67 additions & 0 deletions cfe_ts_crc_version.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
/*
** GSC-18128-1, "Core Flight Executive Version 6.7"
**
** Copyright (c) 2006-2019 United States Government as represented by
** the Administrator of the National Aeronautics and Space Administration.
** All Rights Reserved.
**
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
**
** https://www.apache.org/licenses/LICENSE-2.0
**
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/


/*! @file cfe_ts_crc.h
* @brief Purpose:
* @details Provide version identifiers for the ELF to cFE Table Converter. @n
* See @ref cfsversions for version and build number and description
*
*/

#ifndef CFE_TS_CRC_VERSION_H
#define CFE_TS_CRC_VERSION_H

/*
* Development Build Macro Definitions
*/
#define CFE_TS_CRC_BUILD_NUMBER 8 /*!< @brief Number of commits since baseline */
#define CFE_TS_CRC_BUILD_BASELINE "v1.1.0+dev" /*!< @brief Development Build: git tag that is the base for the current */

/*
* Version Macro Definitions
*/
#define CFE_TS_CRC_MAJOR_VERSION 1 /*!< @brief ONLY APPLY for OFFICIAL releases. Major version number. */
#define CFE_TS_CRC_MINOR_VERSION 1 /*!< @brief ONLY APPLY for OFFICIAL releases. Minor version number. */
#define CFE_TS_CRC_REVISION 0 /*!< @brief ONLY APPLY for OFFICIAL releases. Revision version number. */
#define CFE_TS_CRC_MISSION_REV 0 /*!< @brief ONLY USED by MISSION Implementations. Mission revision */

/*
* Tools to construct version string
*/
#define CFE_TS_CRC_STR_HELPER(x) #x /*!< @brief Helper function to concatenate strings from integer macros */
#define CFE_TS_CRC_STR(x) CFE_TS_CRC_STR_HELPER(x) /*!< @brief Helper function to concatenate strings from integer macros */

/*! @brief Development Build Version Number.
* @details Baseline git tag + Number of commits since baseline. @n
* See @ref cfsversions for format differences between development and release versions.
*/
#define CFE_TS_CRC_VERSION CFE_TS_CRC_BUILD_BASELINE CFE_TS_CRC_STR(CFE_TS_CRC_BUILD_NUMBER)

/*! @brief Development Build Version String.
* @details Reports the current development build's baseline, number, and name. Also includes a note about the latest official version. @n
* See @ref cfsversions for format differences between development and release versions.
*/
#define CFE_TS_CRC_VERSION_STRING \
" cFE tblCRCTool Development Build\n" \
" " CFE_TS_CRC_VERSION " (Codename: Bootes)\n" /* Codename for current development */ \
" Last Offical Release: elf2cfetbl v3.1.0" /* For full support please use official release version */

#endif /* CFE_TS_CRC_VERSION_H */

0 comments on commit 914ad58

Please sign in to comment.