Debian Codegraph @

cmake/tribits/core/package_arch/Tribits_version.h.in

raw
1 /*
2 @REPOSITORY_COPYRIGHT_HEADER@
3 */
4
5 #ifndef @REPOSITORY_NAME_UC@_VERSION_H
6 #define @REPOSITORY_NAME_UC@_VERSION_H
7
8
9 /* @REPOSITORY_NAME@ version numbering convention.
10 *
11 * @REPOSITORY_NAME@ version numbers take the form X.Y.Z where:
12 *
13 * X: The major version number that defines a window of (perfect) backward
14 * compatibility (see below).
15 *
16 * Y: The release version number within a backward-compatible set of
17 * versions X. Even numbers (0, 2, 4, ...) are used for releases and odd
18 * numbers (1, 3, 5, ...) are used for development versions in-between
19 * releases.
20 *
21 * Z: The minor release version number for minor releases taken off off a
22 * release branch X.Y. Even numbers (0, 2, 4, ...) are used for customer
23 * releases and odd numbers (1, 3, 5, ...) are used for the code on the
24 * release X.Y branch in-between minor releases.
25 *
26 * All @REPOSITORY_NAME@ releases (i.e. X.Y where Y is even) are taken off of the
27 * development branch (i.e. the dev version X-1.R or X.Y-1) and are given a
28 * name containing the version number X.Y. The initial releases in a backward
29 * compatible set are then given the release numbers:
30 *
31 * X.0.0, X.2.0, X.4.0, ...
32 *
33 * The intermediate development versions are given the release numbers:
34 *
35 * X.1.0, X.3.0, X.5.0, ....
36 *
37 * For development versions, the minor release version number Z is always 0.
38 *
39 * The minor releases for a given release branch X.Y are given the version
40 * numbers:
41 *
42 * X.Y.0, X.Y.2, X.Y.4, ...
43 *
44 * The version numbers given to the code in the release branch X.Y in-between
45 * minor releases (which are not branched, only tagged) are:
46 *
47 * X.Y.1, X.Y.3, X.Y.5, ...
48 *
49 * In this way, client code can just examine the version number in this file
50 * and know exactly what version of @REPOSITORY_NAME@ they are working with with no
51 * ambiguity no matter what.
52 */
53
54
55 /* The major version number xx (allows up 99 major @REPOSITORY_NAME@ release version
56 * numbers).
57 *
58 * The major @REPOSITORY_NAME@ version number defines a window of backward
59 * compatibility.
60 */
61 #define @REPOSITORY_NAME_UC@_MAJOR_VERSION @REPOSITORY_MAJOR_VERSION@
62
63 /* The major, release, and minor release version numbers (i.e. xx.yy.zz).
64 *
65 * NOTE: When numbers are less than 10, it is padded with a 0. For example,
66 * development version 10.1 of @REPOSITORY_NAME@ is designated 100100 and the release
67 * version 10.2.4 is designated 100204. This preserves the comparability of
68 * these version numbers with simple comparison operators used in #ifdef tests.
69 */
70 #define @REPOSITORY_NAME_UC@_MAJOR_MINOR_VERSION @REPOSITORY_MAJOR_MINOR_VERSION@
71
72 /* NOTE: These macros are given long int values to allow comparisons in
73 * preprocessor #if statements. For example, you can do comparisons with ==,
74 * <, <=, >, and >=.
75 *
76 * NOTE: The C++ standard for the C preprocessor requires that the arguments
77 * for #if must be convertible into a long int. Expressions that convert to 1
78 * are true and expressions that convert to 0 are false.
79 */
80
81 /* \brief Version string for @REPOSITORY_NAME@.
82 *
83 * NOTE: This string is to be used for outputting, not for comparison logic.
84 */
85 #define @REPOSITORY_NAME_UC@_VERSION_STRING "@REPOSITORY_VERSION_STRING@"
86
87 #endif /* @REPOSITORY_NAME_UC@_VERSION_H */