1 #ifndef BABELTRACE2_VERSION_H
2 #define BABELTRACE2_VERSION_H
5 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 #ifndef __BT_IN_BABELTRACE_H
27 # error "Please include <babeltrace2/babeltrace.h> instead."
35 @defgroup api-version Library version
38 Library version getters.
40 This module contains functions to get information about the library's
44 <dt>Major version</dt>
45 <dd>bt_version_get_major()</dd>
47 <dt>Minor version</dt>
48 <dd>bt_version_get_minor()</dd>
50 <dt>Patch version</dt>
51 <dd>bt_version_get_patch()</dd>
53 <dt>\bt_dt_opt Development stage</dt>
54 <dd>bt_version_get_development_stage()</dd>
56 <dt>\bt_dt_opt Version control system revision's description</dt>
57 <dd>bt_version_get_vcs_revision_description()</dd>
59 <dt>\bt_dt_opt Release name</dt>
60 <dd>bt_version_get_name()</dd>
62 <dt>\bt_dt_opt Release name's description</dt>
63 <dd>bt_version_get_name_description()</dd>
65 <dt>\bt_dt_opt Extra name</dt>
66 <dd>bt_version_get_extra_name()</dd>
68 <dt>\bt_dt_opt Extra description</dt>
69 <dd>bt_version_get_extra_description()</dd>
71 <dt>\bt_dt_opt Extra patch names</dt>
72 <dd>bt_version_get_extra_patch_names()</dd>
80 Returns the major version of libbabeltrace2.
83 Major version of the library.
85 extern unsigned int bt_version_get_major(void);
89 Returns the minor version of libbabeltrace2.
92 Minor version of the library.
94 extern unsigned int bt_version_get_minor(void);
98 Returns the patch version of libbabeltrace2.
101 Patch version of the library.
103 extern unsigned int bt_version_get_patch(void);
107 Returns the development stage of libbabeltrace2's version.
109 The development stage \em can contain a version suffix such as
110 <code>-pre5</code> or <code>-rc1</code>.
113 Development stage of the library's version, or \c NULL if none.
115 extern const char *bt_version_get_development_stage(void);
119 Returns the version control system (VCS) revision's description of
120 libbabeltrace2's version.
122 The VCS revision description is only available for a non-release build
126 Version control system revision's description of the library's
127 version, or \c NULL if none.
129 extern const char *bt_version_get_vcs_revision_description(void);
133 Returns libbabeltrace2's release name.
135 If the release name is not available, which can be the case for a
136 development build, this function returns \c NULL.
139 Library's release name, or \c NULL if not available.
141 @sa bt_version_get_name_description() —
142 Returns the description of libbabeltrace2's release name.
144 extern const char *bt_version_get_name(void);
148 Returns libbabeltrace2's release name's description.
150 If the release name's description is not available, which can be the
151 case for a development build, this function returns \c NULL.
154 Library's release name's description, or \c NULL if not available.
156 @sa bt_version_get_name() —
157 Returns libbabeltrace2's release name.
159 extern const char *bt_version_get_name_description(void);
163 Returns the extra name of libbabeltrace2's version.
165 The extra name of the library's version can be set at build time for a
169 Library's version extra name, or \c NULL if not available.
171 extern const char *bt_version_get_extra_name(void);
175 Returns the extra description of libbabeltrace2's version.
177 The extra description of the library's version can be set at build time
182 Library's version extra description, or \c NULL if not available.
184 Can contain newlines.
187 extern const char *bt_version_get_extra_description(void);
191 Returns the extra patch names of libbabeltrace2's version.
193 The extra patch names of the library's version can be set at build time
198 Library's version extra patch names, or \c NULL if not available.
200 Each line of the returned string contains the name of a patch
201 applied to Babeltrace's source tree for a custom build.
204 extern const char *bt_version_get_extra_patch_names(void);
212 #endif /* BABELTRACE2_VERSION_H */
This page took 0.044576 seconds and 4 git commands to generate.