foxBMS - Unit Tests  1.4.0
The foxBMS Unit Tests API Documentation
VER_VERSION_s Struct Reference

#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 [VER_VERSION_STRUCT_MAXIMUM_COMMIT_HASH_LENGTH]
 
const char gitRemote [VER_VERSION_STRUCT_MAXIMUM_REMOTE_STRING_LENGTH]
 

Detailed Description

struct type that describes the version information of the system

Definition at line 78 of file version_cfg.h.

Field Documentation

◆ commitHash

const char VER_VERSION_s::commitHash[VER_VERSION_STRUCT_MAXIMUM_COMMIT_HASH_LENGTH]

hash of the last commit

Definition at line 85 of file version_cfg.h.

◆ distanceFromLastRelease

const uint16_t VER_VERSION_s::distanceFromLastRelease

distance in commits from the last tagged release in version control

Definition at line 84 of file version_cfg.h.

◆ gitRemote

const char VER_VERSION_s::gitRemote[VER_VERSION_STRUCT_MAXIMUM_REMOTE_STRING_LENGTH]

address of the git remote linked in the repository

Definition at line 86 of file version_cfg.h.

◆ isDirty

const bool VER_VERSION_s::isDirty

indicates whether the code deviates from the last versioned state

Definition at line 80 of file version_cfg.h.

◆ major

const uint8_t VER_VERSION_s::major

major release version

Definition at line 81 of file version_cfg.h.

◆ minor

const uint8_t VER_VERSION_s::minor

minor release version

Definition at line 82 of file version_cfg.h.

◆ patch

const uint8_t VER_VERSION_s::patch

patch release version

Definition at line 83 of file version_cfg.h.

◆ underVersionControl

const bool VER_VERSION_s::underVersionControl

indicates whether the toolchain has detected version control

Definition at line 79 of file version_cfg.h.


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