@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>
<dt>Patch version</dt>
<dd>bt_version_get_patch()</dd>
- <dt>Extra information</dt>
- <dd>bt_version_get_extra()</dd>
-</dl>
+ <dt>\bt_dt_opt Development stage</dt>
+ <dd>bt_version_get_development_stage()</dd>
+
+ <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>
-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 Release name's description</dt>
+ <dd>bt_version_get_name_description()</dd>
+</dl>
*/
/*! @{ */
/*!
@brief
- Returns extra information about the version of libbabeltrace2.
+ Returns the development stage of libbabeltrace2's version.
-This extra information can contain a version suffix such as
+The development stage \em can contain a version suffix such as
<code>-pre5</code> or <code>-rc1</code>.
@returns
- Extra information about the library's version, or \c NULL if none.
+ Development stage of the library's version, or \c NULL if none.
+*/
+extern const char *bt_version_get_development_stage(void);
+
+/*!
+@brief
+ 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_extra(void);
+extern const char *bt_version_get_vcs_revision_description(void);
/*!
@brief
- Returns libbabeltrace2's version name.
+ 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
- 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() —
- 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
- 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
- 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() —
- Returns libbabeltrace2's version name.
+ Returns libbabeltrace2's release name.
*/
extern const char *bt_version_get_name_description(void);