File: version-defines-template.h

package info (click to toggle)
ns3 3.47-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 106,848 kB
  • sloc: cpp: 633,577; python: 15,491; ansic: 6,773; makefile: 1,959; sh: 1,021; pascal: 632; javascript: 167; perl: 102
file content (137 lines) | stat: -rw-r--r-- 3,415 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/*
 * Copyright (c) 2018 Lawrence Livermore National Laboratory
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 * Authors: Mathew Bielejeski <bielejeski1@llnl.gov>
 */

// clang-format off

#ifndef NS3_VERSION_DEFINES_H_
#define NS3_VERSION_DEFINES_H_

/**
 * \file
 * \ingroup buildversion
 * Defines the macro values for printing the build version.
 * These will be populated by the build system.
 */

/**
 * \ingroup buildversion
 * @{
 */

/**
 * The first tag found which matches the pattern ns-3*.
 *
 * The expected format of the ns-3 version tag is: ns-3.<minor>[.patch][-release_candidate]
 *
 * The tag is found by starting at the tip of the current branch and walking
 * back towards the root.
 *
 * Type: string literal
 */
#cmakedefine NS3_VERSION_TAG "@NS3_VERSION_TAG@"

/**
 * The tag closest to the tip of the current branch
 *
 * The tag is found by starting at the tip of the current branch and
 * walking back towards the root.
 *
 * This value will be the same as #NS3_VERSION_TAG when #NS3_VERSION_TAG is
 * the closest tag.
 *
 * Type: string literal
 */
#cmakedefine NS3_VERSION_CLOSEST_TAG "@NS3_VERSION_CLOSEST_TAG@"

/**
 * The major version extracted from #NS3_VERSION_TAG
 *
 * For a tag with the format ns-<digit>.<digit>[.digit], the major
 * version is the number after ns- and before the first period.
 *
 * Type: integer
 */
#define NS3_VERSION_MAJOR @NS3_VERSION_MAJOR@

/**
 * The minor version extracted from #NS3_VERSION_TAG
 *
 * For a tag with the format ns-<digit>.<digit>[.digit], the minor
 * version is the number after the first period.
 *
 * Type: integer
 */
#define NS3_VERSION_MINOR @NS3_VERSION_MINOR@

/**
 * The patch number extracted from #NS3_VERSION_TAG
 *
 * For a tag with the format ns-<digit>.<digit>[.digit], the patch
 * is the number after the last period.
 *
 * The patch value is optional and may not be present in the tag.
 * In cases where the patch value is not present, the field will be set to 0
 *
 * Type: integer
 */
#define NS3_VERSION_PATCH @NS3_VERSION_PATCH@

/**
 * The portion of the #NS3_VERSION_TAG indicating the version
 * of the release candidate (if applicable).
 *
 * In order for this field to contain a value, the #NS3_VERSION_TAG
 * must have the format ns-<digit>.<digit>[.digit][-RC<digit>].
 * The contents of the release candidate will be the RC<digit>
 * portion of the tag.
 *
 * Type: string literal
 */
#cmakedefine NS3_VERSION_RELEASE_CANDIDATE @NS3_VERSION_RELEASE_CANDIDATE@

/**
 * The number of repository commits between #NS3_VERSION_CLOSEST_TAG
 * and the branch HEAD.
 *
 * Type: integer
 */
#define NS3_VERSION_TAG_DISTANCE @NS3_VERSION_TAG_DISTANCE@

/**
 * Hash value which uniquely identifies the commit of the
 * branch HEAD.
 * The first character of the commit hash is 'g' to indicate this hash is
 * a git hash
 *
 * Type: string literal
 */
#cmakedefine NS3_VERSION_COMMIT_HASH "@NS3_VERSION_COMMIT_HASH@"

/**
 * Flag indicating whether the repository working tree had uncommitted
 * changes when the library was built.
 *
 * The flag will be 1 if there were uncommitted changes, 0 otherwise.
 *
 * Type: integer
 */
#cmakedefine01 NS3_VERSION_DIRTY_FLAG

/**
 * Indicates the build profile that was specified by the --build-profile option
 * of "ns3 configure"
 *
 * Type: string literal
 */
#cmakedefine NS3_VERSION_BUILD_PROFILE "@NS3_VERSION_BUILD_PROFILE@"

/** @} */

#endif

// clang-format on