For a non-release build, this function returns the Git revision's
description.
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: Iec5e5fb1bb220c3477bfecab3c3f35b103c0592e
Reviewed-on: https://review.lttng.org/c/babeltrace/+/2837
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Tested-by: jenkins <jenkins@lttng.org>
@brief
Library version getters.
@brief
Library version getters.
-This module contains four functions to get the four parts of the
-library's version:
+This module contains four functions to information about the library's
+version:
<dl>
<dt>Major version</dt>
<dl>
<dt>Major version</dt>
<dt>Patch version</dt>
<dd>bt_version_get_patch()</dd>
<dt>Patch version</dt>
<dd>bt_version_get_patch()</dd>
- <dt>Development stage</dt>
+ <dt>\bt_dt_opt Development stage</dt>
<dd>bt_version_get_development_stage()</dd>
<dd>bt_version_get_development_stage()</dd>
-You can also get the version's name and description if available with
-bt_version_get_name() and bt_version_get_name_description().
+ <dt>\bt_dt_opt Version control system revision's description</dt>
+ <dd>bt_version_get_vcs_revision_description()</dd>
+
+ <dt>\bt_dt_opt Release name</dt>
+ <dd>bt_version_get_name()</dd>
+
+ <dt>\bt_dt_opt Release name's description</dt>
+ <dd>bt_version_get_name_description()</dd>
+</dl>
- Returns libbabeltrace2's version name.
+ 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 \c NULL if none.
+*/
+extern const char *bt_version_get_vcs_revision_description(void);
+
+/*!
+@brief
+ Returns libbabeltrace2's release name.
-If the version name is not available, which can be the case for a
+If the release name is not available, which can be the case for a
development build, this function returns \c NULL.
@returns
development build, this function returns \c NULL.
@returns
- Library's version name, or \c NULL if not available.
+ Library's release name, or \c NULL if not available.
@sa bt_version_get_name_description() —
@sa bt_version_get_name_description() —
- Returns the description of libbabeltrace2's version name.
+ Returns the description of libbabeltrace2's release name.
*/
extern const char *bt_version_get_name(void);
/*!
@brief
*/
extern const char *bt_version_get_name(void);
/*!
@brief
- Returns libbabeltrace2's version name's description.
+ Returns libbabeltrace2's release name's description.
-If the version name's description is not available, which can be the
+If the release name's description is not available, which can be the
case for a development build, this function returns \c NULL.
@returns
case for a development build, this function returns \c NULL.
@returns
- Library's version name's description, or \c NULL if not available.
+ Library's release name's description, or \c NULL if not available.
@sa bt_version_get_name() —
@sa bt_version_get_name() —
- Returns libbabeltrace2's version name.
+ Returns libbabeltrace2's release name.
*/
extern const char *bt_version_get_name_description(void);
*/
extern const char *bt_version_get_name_description(void);
#include <stdlib.h>
#include <string.h>
#include <stdlib.h>
#include <string.h>
+#include "common/version.h"
+
unsigned int bt_version_get_major(void)
{
return BT_VERSION_MAJOR;
unsigned int bt_version_get_major(void)
{
return BT_VERSION_MAJOR;
return strlen(BT_VERSION_DEV_STAGE) == 0 ? NULL : BT_VERSION_DEV_STAGE;
}
return strlen(BT_VERSION_DEV_STAGE) == 0 ? NULL : BT_VERSION_DEV_STAGE;
}
+const char *bt_version_get_vcs_revision_description(void)
+{
+ return strlen(BT_VERSION_GIT) == 0 ? NULL : BT_VERSION_GIT;
+}
+
const char *bt_version_get_name(void)
{
return strlen(BT_VERSION_NAME) == 0 ? NULL : BT_VERSION_NAME;
const char *bt_version_get_name(void)
{
return strlen(BT_VERSION_NAME) == 0 ? NULL : BT_VERSION_NAME;