lib: add bt_version_get_extra_{name,description,patch_names}

Those new functions return extra information about the library's version
for custom builds (see `version/README.adoc`).

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Change-Id: I52abca8235826d1e336584285e925147895b13f4
Reviewed-on: https://review.lttng.org/c/babeltrace/+/2838
Reviewed-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Tested-by: jenkins <jenkins@lttng.org>

diff --git a/include/babeltrace2/version.h b/include/babeltrace2/version.h
index 8ced70e10a0aaae5ae5248a73bab31338760594f..a1d27864eb35b2c3996d336cdfe30d0362148043 100644 (file)
--- a/include/babeltrace2/version.h
+++ b/include/babeltrace2/version.h
@@ -37,7 +37,7 @@ extern "C" {
 @brief
     Library version getters.
 
-This module contains four functions to information about the library's
+This module contains functions to get information about the library's
 version:
 
 <dl>
@@ -61,6 +61,15 @@ version:
 
   <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>
 */
 
@@ -149,6 +158,51 @@ case for a development build, this function returns \c NULL.
 */
 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

diff --git a/src/lib/babeltrace2.c b/src/lib/babeltrace2.c
index ce01e7282dd01eab863dc3475210c90e2d53d292..95ea7fb8e1b5ec18812c508fd4fdc331eab1c31a 100644 (file)
--- a/src/lib/babeltrace2.c
+++ b/src/lib/babeltrace2.c
@@ -63,3 +63,21 @@ const char *bt_version_get_name_description(void)
        return strlen(BT_VERSION_DESCRIPTION) == 0 ? NULL :
                BT_VERSION_DESCRIPTION;
 }
+
+const char *bt_version_get_extra_name(void)
+{
+       return strlen(BT_VERSION_EXTRA_NAME) == 0 ? NULL :
+               BT_VERSION_EXTRA_NAME;
+}
+
+const char *bt_version_get_extra_description(void)
+{
+       return strlen(BT_VERSION_EXTRA_DESCRIPTION) == 0 ? NULL :
+               BT_VERSION_EXTRA_DESCRIPTION;
+}
+
+const char *bt_version_get_extra_patch_names(void)
+{
+       return strlen(BT_VERSION_EXTRA_PATCHES) == 0 ? NULL :
+               BT_VERSION_EXTRA_PATCHES;
+}