RTEMS 6.1-rc5
|
The Version API provides functions to return the version or parts of the version of RTEMS you are using. More...
Files | |
file | version.h |
This header file provides the Version API. | |
Functions | |
const char * | rtems_version (void) |
Returns the version string. | |
int | rtems_version_major (void) |
Returns the version's major number. | |
int | rtems_version_minor (void) |
Returns the version's minor number. | |
int | rtems_version_revision (void) |
Returns the version's revision number. | |
const char * | rtems_version_control_key (void) |
Returns the version control key for the current version of code that has been built. | |
const char * | rtems_version_release_label (void) |
Returns the revision label for the current version of code that has been built. | |
bool | rtems_version_release_label_is_valid (void) |
Returns true, if the release label is valid, otherwise false. | |
const char * | rtems_board_support_package (void) |
Returns the board support package name. | |
The Version API provides functions to return the version or parts of the version of RTEMS you are using.
A branch in the version control system will always fall back to a NOT-RELEASED version number with a minor number of 0. Only the release archives have a VERSION file with a final release number. That means for example that the 5 development branch will still show a version 5.0.0 even after the 5.1 release.
The reason for that are the following:
const char * rtems_board_support_package | ( | void | ) |
Returns the board support package name.
const char * rtems_version | ( | void | ) |
Returns the version string.
text | The version as a string. |
const char * rtems_version_control_key | ( | void | ) |
Returns the version control key for the current version of code that has been built.
The key is specific to the version control system being used and allows the built version to be identified.
Use rtems_version_control_key_is_valid() to check if the version control key is valid.
int rtems_version_major | ( | void | ) |
Returns the version's major number.
int | The version's major number. |
int rtems_version_minor | ( | void | ) |
Returns the version's minor number.
int | The version's minor number. |
const char * rtems_version_release_label | ( | void | ) |
Returns the revision label for the current version of code that has been built.
The release label is a string of characters. Only the RTEMS project released sources can have an empty release label.
Use rtems_version_release_label_is_valid() to check if the release label is valid.
bool rtems_version_release_label_is_valid | ( | void | ) |
Returns true, if the release label is valid, otherwise false.
true | The release label is valid. |
false | Otherwise. |
int rtems_version_revision | ( | void | ) |
Returns the version's revision number.
int | The version's revision number. |