2 * SPDX-License-Identifier: MIT
4 * Copyright (C) 2010-2019 EfficiOS Inc. and Linux Foundation
7 #ifndef BABELTRACE2_VERSION_H
8 #define BABELTRACE2_VERSION_H
10 /* IWYU pragma: private, include <babeltrace2/babeltrace.h> */
12 #ifndef __BT_IN_BABELTRACE_H
13 # error "Please include <babeltrace2/babeltrace.h> instead."
21 @defgroup api-version Library version
24 Library version getters.
26 This API offers functions to get information about the
30 <dt>Major version</dt>
31 <dd>bt_version_get_major()</dd>
33 <dt>Minor version</dt>
34 <dd>bt_version_get_minor()</dd>
36 <dt>Patch version</dt>
37 <dd>bt_version_get_patch()</dd>
39 <dt>\bt_dt_opt Development stage</dt>
40 <dd>bt_version_get_development_stage()</dd>
42 <dt>\bt_dt_opt Version control system revision's description</dt>
43 <dd>bt_version_get_vcs_revision_description()</dd>
45 <dt>\bt_dt_opt Release name</dt>
46 <dd>bt_version_get_name()</dd>
48 <dt>\bt_dt_opt Release name's description</dt>
49 <dd>bt_version_get_name_description()</dd>
51 <dt>\bt_dt_opt Extra name</dt>
52 <dd>bt_version_get_extra_name()</dd>
54 <dt>\bt_dt_opt Extra description</dt>
55 <dd>bt_version_get_extra_description()</dd>
57 <dt>\bt_dt_opt Extra patch names</dt>
58 <dd>bt_version_get_extra_patch_names()</dd>
66 Returns the major version of libbabeltrace2.
69 Major version of the library.
71 extern unsigned int bt_version_get_major(void) __BT_NOEXCEPT
;
75 Returns the minor version of libbabeltrace2.
78 Minor version of the library.
80 extern unsigned int bt_version_get_minor(void) __BT_NOEXCEPT
;
84 Returns the patch version of libbabeltrace2.
87 Patch version of the library.
89 extern unsigned int bt_version_get_patch(void) __BT_NOEXCEPT
;
93 Returns the development stage of libbabeltrace2's version.
95 The development stage \em can contain a version suffix such as
96 <code>-pre5</code> or <code>-rc1</code>.
99 Development stage of the library's version, or \c NULL if none.
101 extern const char *bt_version_get_development_stage(void) __BT_NOEXCEPT
;
105 Returns the version control system (VCS) revision's description of
106 libbabeltrace2's version.
108 The VCS revision description is only available for a non-release build
112 Version control system revision's description of the library's
113 version, or \c NULL if none.
115 extern const char *bt_version_get_vcs_revision_description(void) __BT_NOEXCEPT
;
119 Returns libbabeltrace2's release name.
121 If the release name is not available, which can be the case for a
122 development build, this function returns \c NULL.
125 Library's release name, or \c NULL if not available.
127 @sa bt_version_get_name_description() —
128 Returns the description of libbabeltrace2's release name.
130 extern const char *bt_version_get_name(void) __BT_NOEXCEPT
;
134 Returns libbabeltrace2's release name's description.
136 If the release name's description is not available, which can be the
137 case for a development build, this function returns \c NULL.
140 Library's release name's description, or \c NULL if not available.
142 @sa bt_version_get_name() —
143 Returns libbabeltrace2's release name.
145 extern const char *bt_version_get_name_description(void) __BT_NOEXCEPT
;
149 Returns the extra name of libbabeltrace2's version.
151 The extra name of the library's version can be set at build time for a
155 Library's version extra name, or \c NULL if not available.
157 extern const char *bt_version_get_extra_name(void) __BT_NOEXCEPT
;
161 Returns the extra description of libbabeltrace2's version.
163 The extra description of the library's version can be set at build time
168 Library's version extra description, or \c NULL if not available.
170 Can contain newlines.
173 extern const char *bt_version_get_extra_description(void) __BT_NOEXCEPT
;
177 Returns the extra patch names of libbabeltrace2's version.
179 The extra patch names of the library's version can be set at build time
184 Library's version extra patch names, or \c NULL if not available.
186 Each line of the returned string contains the name of a patch
187 applied to Babeltrace's source tree for a custom build.
190 extern const char *bt_version_get_extra_patch_names(void) __BT_NOEXCEPT
;
198 #endif /* BABELTRACE2_VERSION_H */
This page took 0.039181 seconds and 4 git commands to generate.