Library version

Detailed Description

Library version getters.

This API offers functions to get information about the version of the library:

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: Description of the version control system revision

bt_version_get_vcs_revision_description()

Optional: Release name

bt_version_get_name()

Optional: Description of the release name

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.
unsigned int	bt_version_get_minor (void)
	Returns the minor version of libbabeltrace2.
unsigned int	bt_version_get_patch (void)
	Returns the patch version of libbabeltrace2.
const char *	bt_version_get_development_stage (void)
	Returns the development stage of libbabeltrace2's version.
const char *	bt_version_get_vcs_revision_description (void)
	Returns the description of the version control system (VCS) revision of libbabeltrace2's version.
const char *	bt_version_get_name (void)
	Returns libbabeltrace2's release name.
const char *	bt_version_get_name_description (void)
	Returns the description of libbabeltrace2's release name.
const char *	bt_version_get_extra_name (void)
	Returns the extra name of libbabeltrace2's version.
const char *	bt_version_get_extra_description (void)
	Returns the extra description of libbabeltrace2's version.
const char *	bt_version_get_extra_patch_names (void)
	Returns the extra patch names of libbabeltrace2's version.

Function Documentation

bt_version_get_major()

unsigned int bt_version_get_major ( void )

extern

Returns the major version of libbabeltrace2.

Returns

Major version of the library.

bt_version_get_minor()

unsigned int bt_version_get_minor ( void )

extern

Returns the minor version of libbabeltrace2.

Returns

Minor version of the library.

bt_version_get_patch()

unsigned int bt_version_get_patch ( void )

extern

Returns the patch version of libbabeltrace2.

Returns

Patch version of the library.

bt_version_get_development_stage()

const char * bt_version_get_development_stage ( void )

extern

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 version of the library, or NULL if none.

bt_version_get_vcs_revision_description()

const char * bt_version_get_vcs_revision_description ( void )

extern

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

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

Returns

Description of the version control system revision of the version of the library, or NULL if none.

bt_version_get_name()

const char * bt_version_get_name ( void )

extern

Returns libbabeltrace2's release name.

If the release name isn't available, which can be the case for a development build, then this function returns NULL.

Returns

Release name of the library, or NULL if not available.

See also

bt_version_get_name_description() — Returns the description of libbabeltrace2's release name.

bt_version_get_name_description()

const char * bt_version_get_name_description ( void )

extern

Returns the description of libbabeltrace2's release name.

If the description of the release name isn't available, which can be the case for a development build, then this function returns NULL.

Returns

Description of the release name of the library, or NULL if not available.

See also

bt_version_get_name() — Returns libbabeltrace2's release name.

bt_version_get_extra_name()

const char * bt_version_get_extra_name ( void )

extern

Returns the extra name of libbabeltrace2's version.

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

Returns

Extra name of the version of the library, or NULL if not available.

bt_version_get_extra_description()

const char * bt_version_get_extra_description ( void )

extern

Returns the extra description of libbabeltrace2's version.

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

Returns

Extra description of the version of the library, or NULL if not available.

Can contain newlines.

bt_version_get_extra_patch_names()

const char * bt_version_get_extra_patch_names ( void )

extern

Returns the extra patch names of libbabeltrace2's version.

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

Returns

Extra patch names of the version of the library, 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.