hal
Hardware Abstraction Layer
Public Attributes | List of all members
hal_metadata_t Struct Reference

Struct contains all build and version metadata of HAL. More...

#include <hal_metadata.h>

Public Attributes

unsigned major
 
unsigned minor
 
unsigned patch
 
const char * version_str
 
const char * git_hash
 
const char * build_date
 
unsigned dirty
 
const char * dirty_str
 

Detailed Description

Struct contains all build and version metadata of HAL.

Member Data Documentation

◆ build_date

const char* hal_metadata_t::build_date

Date of build. ("year-month-day")

◆ dirty

unsigned hal_metadata_t::dirty

1 if there are uncommitted changes included in this build. (And therefore unknown changes) 0 otherwise.

◆ dirty_str

const char* hal_metadata_t::dirty_str

Easily printable string representing dirty/clean status. ("dirty", "clean", "unknown")

◆ git_hash

const char* hal_metadata_t::git_hash

Compact hash of the current commit during build.

◆ major

unsigned hal_metadata_t::major

Major version. API level breaking changes.

◆ minor

unsigned hal_metadata_t::minor

Minor version. Major feature additions without breaking changes.

◆ patch

unsigned hal_metadata_t::patch

Patch. Bug fixes and small additions without breaking changes.

◆ version_str

const char* hal_metadata_t::version_str

String containing major.minor.path ("x.y.z")

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