X-Git-Url: https://git.efficios.com/?a=blobdiff_plain;f=include%2Fbabeltrace2%2Fversion.h;h=a1d27864eb35b2c3996d336cdfe30d0362148043;hb=a0446fa8710ece12a7b9457e1b0e03ce7e4fc2c4;hp=1a15af439fb8f304ff1c5ffe39f2bcb506cd060a;hpb=4f79144c96b0f66d0f2913005be267060b925315;p=babeltrace.git diff --git a/include/babeltrace2/version.h b/include/babeltrace2/version.h index 1a15af43..a1d27864 100644 --- a/include/babeltrace2/version.h +++ b/include/babeltrace2/version.h @@ -31,10 +31,179 @@ extern "C" { #endif +/*! +@defgroup api-version Library version + +@brief + Library version getters. + +This module contains functions to get information about the library's +version: + +
-pre5
or -rc1
.
+
+@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
+ Library's version extra description, or \c NULL if not available.
+
+ Can contain newlines.
+ @endparblock
+*/
+extern const char *bt_version_get_extra_description(void);
+
+/*!
+@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.
+
+ 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_patch_names(void);
+
+/*! @} */
#ifdef __cplusplus
}