@brief
Library version getters.
-This module contains four functions to get the four parts of the
-library's version:
+This module contains functions to get 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>
+ <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>
+
+ <dt>\bt_dt_opt Release name's description</dt>
+ <dd>bt_version_get_name_description()</dd>
+
+ <dt>\bt_dt_opt Extra name</dt>
+ <dd>bt_version_get_extra_name()</dd>
+
+ <dt>\bt_dt_opt Extra description</dt>
+ <dd>bt_version_get_extra_description()</dd>
+
+ <dt>\bt_dt_opt Extra patch names</dt>
+ <dd>bt_version_get_extra_patch_names()</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
+ 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_vcs_revision_description(void);
+
+/*!
+@brief
+ Returns libbabeltrace2's release name.
+
+If the release name is not available, which can be the case for a
+development build, this function returns \c NULL.
+
+@returns
+ Library's release name, or \c NULL if not available.
+
+@sa bt_version_get_name_description() —
+ Returns the description of libbabeltrace2's release name.
+*/
+extern const char *bt_version_get_name(void);
+
+/*!
+@brief
+ 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 \c NULL.
+
+@returns
+ Library's release name's description, or \c NULL if not available.
+
+@sa bt_version_get_name() —
+ Returns libbabeltrace2's release name.
+*/
+extern const char *bt_version_get_name_description(void);
+
+/*!
+@brief
+ 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 \c NULL if not available.
+*/
+extern const char *bt_version_get_extra_name(void);
+
+/*!
+@brief
+ 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
@parblock
- Extra information about the library's version.
+ Library's version extra description, or \c NULL if not available.
+
+ Can contain newlines.
+ @endparblock
+*/
+extern const char *bt_version_get_extra_description(void);
- Cannot be \c NULL.
+/*!
+@brief
+ 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
+ @parblock
+ Library's version extra patch names, or \c NULL if not available.
- Can be an empty string if there's no extra information.
+ Each line of the returned string contains the name of a patch
+ applied to Babeltrace's source tree for a custom build.
@endparblock
*/
-extern const char *bt_version_get_extra(void);
+extern const char *bt_version_get_extra_patch_names(void);
/*! @} */