Babeltrace 2 C API  2.0.3
Open-source trace manipulation framework
 All Functions Variables Typedefs Enumerations Enumerator Modules Pages
Functions
Library version

Detailed Description

Library version getters.

This module contains functions to get information about the library's version:

Major version

bt_version_get_major()

Minor version

bt_version_get_minor()

Patch version

bt_version_get_patch()

Optional: Development stage

bt_version_get_development_stage()

Optional: Version control system revision's description

bt_version_get_vcs_revision_description()

Optional: Release name

bt_version_get_name()

Optional: Release name's description

bt_version_get_name_description()

Optional: Extra name

bt_version_get_extra_name()

Optional: Extra description

bt_version_get_extra_description()

Optional: Extra patch names
bt_version_get_extra_patch_names()

Functions

unsigned int bt_version_get_major (void)
 Returns the major version of libbabeltrace2. More...
 
unsigned int bt_version_get_minor (void)
 Returns the minor version of libbabeltrace2. More...
 
unsigned int bt_version_get_patch (void)
 Returns the patch version of libbabeltrace2. More...
 
const char * bt_version_get_development_stage (void)
 Returns the development stage of libbabeltrace2's version. More...
 
const char * bt_version_get_vcs_revision_description (void)
 Returns the version control system (VCS) revision's description of libbabeltrace2's version. More...
 
const char * bt_version_get_name (void)
 Returns libbabeltrace2's release name. More...
 
const char * bt_version_get_name_description (void)
 Returns libbabeltrace2's release name's description. More...
 
const char * bt_version_get_extra_name (void)
 Returns the extra name of libbabeltrace2's version. More...
 
const char * bt_version_get_extra_description (void)
 Returns the extra description of libbabeltrace2's version. More...
 
const char * bt_version_get_extra_patch_names (void)
 Returns the extra patch names of libbabeltrace2's version. More...
 

Function Documentation

unsigned int bt_version_get_major ( void  )

Returns the major version of libbabeltrace2.

Returns
Major version of the library.
unsigned int bt_version_get_minor ( void  )

Returns the minor version of libbabeltrace2.

Returns
Minor version of the library.
unsigned int bt_version_get_patch ( void  )

Returns the patch version of libbabeltrace2.

Returns
Patch version of the library.
const char* bt_version_get_development_stage ( void  )

Returns the development stage of libbabeltrace2's version.

The development stage can contain a version suffix such as -pre5 or -rc1.

Returns
Development stage of the library's version, or NULL if none.
const char* bt_version_get_vcs_revision_description ( void  )

Returns the version control system (VCS) revision's description of libbabeltrace2's version.

The VCS revision description is only available for a non-release build of the library.

Returns
Version control system revision's description of the library's version, or NULL if none.
const char* bt_version_get_name ( void  )

Returns libbabeltrace2's release name.

If the release name is not available, which can be the case for a development build, this function returns NULL.

Returns
Library's release name, or NULL if not available.
See also
bt_version_get_name_description() — Returns the description of libbabeltrace2's release name.
const char* bt_version_get_name_description ( void  )

Returns libbabeltrace2's release name's description.

If the release name's description is not available, which can be the case for a development build, this function returns NULL.

Returns
Library's release name's description, or NULL if not available.
See also
bt_version_get_name() — Returns libbabeltrace2's release name.
const char* bt_version_get_extra_name ( void  )

Returns the extra name of libbabeltrace2's version.

The extra name of the library's version can be set at build time for a custom build.

Returns
Library's version extra name, or NULL if not available.
const char* bt_version_get_extra_description ( void  )

Returns the extra description of libbabeltrace2's version.

The extra description of the library's version can be set at build time for a custom build.

Returns

Library's version extra description, or NULL if not available.

Can contain newlines.

const char* bt_version_get_extra_patch_names ( void  )

Returns the extra patch names of libbabeltrace2's version.

The extra patch names of the library's version can be set at build time for a custom build.

Returns

Library's version extra patch names, or NULL if not available.

Each line of the returned string contains the name of a patch applied to Babeltrace's source tree for a custom build.