RTEMS  5.1
Files | Functions
Version

The Version API provides functions to return the version or parts of the version of RTEMS you are using. More...

Files

file  version.c
 Creates the version strings from the various pieces of version information. The main version number is part of the build system and is stamped into rtems/score/cpuopts.h. The version control key string is extracted from the version control tool when the code is being built and is updated if it has changed. The key may indicate there are local modification.
 

Functions

const char * rtems_version (void)
 Returns the version string. More...
 
int rtems_version_major (void)
 Returns the version's major number. More...
 
int rtems_version_minor (void)
 Returns the version's minor number. More...
 
int rtems_version_revision (void)
 Returns the version's revision number. More...
 
const char * rtems_version_control_key (void)
 Returns the version control key for the current version of code that has been built. More...
 
const char * rtems_board_support_package (void)
 Returns the board support package name. More...
 

Detailed Description

The Version API provides functions to return the version or parts of the version of RTEMS you are using.

Function Documentation

◆ rtems_board_support_package()

const char* rtems_board_support_package ( void  )

Returns the board support package name.

Returns
The board support package name.

◆ rtems_version()

const char* rtems_version ( void  )

Returns the version string.

Return values
textThe version as a string.

◆ rtems_version_control_key()

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.

Returns
The version control key.

◆ rtems_version_major()

int rtems_version_major ( void  )

Returns the version's major number.

Return values
intThe version's major number.

◆ rtems_version_minor()

int rtems_version_minor ( void  )

Returns the version's minor number.

Return values
intThe version's minor number.

◆ rtems_version_revision()

int rtems_version_revision ( void  )

Returns the version's revision number.

Return values
intThe version's revision number.