#include <version_cfg.h>

Data Fields
const bool	underVersionControl

const bool	isDirty

const uint8_t	major

const uint8_t	minor

const uint8_t	patch

const uint16_t	distanceFromLastRelease

const char	commitHash [VERSION_STRUCT_MAXIMUM_COMMIT_HASH_LENGTH]

const char	gitRemote [VERSION_STRUCT_MAXIMUM_REMOTE_STRING_LENGTH]

Detailed Description

struct type that describes the version information of the system

Definition at line 77 of file version_cfg.h.

Field Documentation

◆ commitHash

const char VERSION::commitHash[VERSION_STRUCT_MAXIMUM_COMMIT_HASH_LENGTH]

hash of the last commit

Definition at line 84 of file version_cfg.h.

◆ distanceFromLastRelease

const uint16_t VERSION::distanceFromLastRelease

distance in commits from the last tagged release in version control

Definition at line 83 of file version_cfg.h.

◆ gitRemote

const char VERSION::gitRemote[VERSION_STRUCT_MAXIMUM_REMOTE_STRING_LENGTH]

address of the git remote linked in the repository

Definition at line 85 of file version_cfg.h.

◆ isDirty

const bool VERSION::isDirty

indicates whether the code deviates from the last versioned state

Definition at line 79 of file version_cfg.h.

◆ major

const uint8_t VERSION::major

major release version

Definition at line 80 of file version_cfg.h.

◆ minor

const uint8_t VERSION::minor

minor release version

Definition at line 81 of file version_cfg.h.

◆ patch

const uint8_t VERSION::patch

patch release version

Definition at line 82 of file version_cfg.h.

◆ underVersionControl

const bool VERSION::underVersionControl

indicates whether the toolchain has detected version control

Definition at line 78 of file version_cfg.h.

The documentation for this struct was generated from the following file:

version_cfg.h

Data Fields