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 #ifndef __BT_IN_BABELTRACE_H
11 # error "Please include <babeltrace2/babeltrace.h> instead."
19 @defgroup api-version Library version
22 Library version getters.
24 This module contains functions to get information about the library's
28 <dt>Major version</dt>
29 <dd>bt_version_get_major()</dd>
31 <dt>Minor version</dt>
32 <dd>bt_version_get_minor()</dd>
34 <dt>Patch version</dt>
35 <dd>bt_version_get_patch()</dd>
37 <dt>\bt_dt_opt Development stage</dt>
38 <dd>bt_version_get_development_stage()</dd>
40 <dt>\bt_dt_opt Version control system revision's description</dt>
41 <dd>bt_version_get_vcs_revision_description()</dd>
43 <dt>\bt_dt_opt Release name</dt>
44 <dd>bt_version_get_name()</dd>
46 <dt>\bt_dt_opt Release name's description</dt>
47 <dd>bt_version_get_name_description()</dd>
49 <dt>\bt_dt_opt Extra name</dt>
50 <dd>bt_version_get_extra_name()</dd>
52 <dt>\bt_dt_opt Extra description</dt>
53 <dd>bt_version_get_extra_description()</dd>
55 <dt>\bt_dt_opt Extra patch names</dt>
56 <dd>bt_version_get_extra_patch_names()</dd>
64 Returns the major version of libbabeltrace2.
67 Major version of the library.
69 extern unsigned int bt_version_get_major(void);
73 Returns the minor version of libbabeltrace2.
76 Minor version of the library.
78 extern unsigned int bt_version_get_minor(void);
82 Returns the patch version of libbabeltrace2.
85 Patch version of the library.
87 extern unsigned int bt_version_get_patch(void);
91 Returns the development stage of libbabeltrace2's version.
93 The development stage \em can contain a version suffix such as
94 <code>-pre5</code> or <code>-rc1</code>.
97 Development stage of the library's version, or \c NULL if none.
99 extern const char *bt_version_get_development_stage(void);
103 Returns the version control system (VCS) revision's description of
104 libbabeltrace2's version.
106 The VCS revision description is only available for a non-release build
110 Version control system revision's description of the library's
111 version, or \c NULL if none.
113 extern const char *bt_version_get_vcs_revision_description(void);
117 Returns libbabeltrace2's release name.
119 If the release name is not available, which can be the case for a
120 development build, this function returns \c NULL.
123 Library's release name, or \c NULL if not available.
125 @sa bt_version_get_name_description() —
126 Returns the description of libbabeltrace2's release name.
128 extern const char *bt_version_get_name(void);
132 Returns libbabeltrace2's release name's description.
134 If the release name's description is not available, which can be the
135 case for a development build, this function returns \c NULL.
138 Library's release name's description, or \c NULL if not available.
140 @sa bt_version_get_name() —
141 Returns libbabeltrace2's release name.
143 extern const char *bt_version_get_name_description(void);
147 Returns the extra name of libbabeltrace2's version.
149 The extra name of the library's version can be set at build time for a
153 Library's version extra name, or \c NULL if not available.
155 extern const char *bt_version_get_extra_name(void);
159 Returns the extra description of libbabeltrace2's version.
161 The extra description of the library's version can be set at build time
166 Library's version extra description, or \c NULL if not available.
168 Can contain newlines.
171 extern const char *bt_version_get_extra_description(void);
175 Returns the extra patch names of libbabeltrace2's version.
177 The extra patch names of the library's version can be set at build time
182 Library's version extra patch names, or \c NULL if not available.
184 Each line of the returned string contains the name of a patch
185 applied to Babeltrace's source tree for a custom build.
188 extern const char *bt_version_get_extra_patch_names(void);
196 #endif /* BABELTRACE2_VERSION_H */
This page took 0.035127 seconds and 4 git commands to generate.