Commit | Line | Data |
---|---|---|
89e18e1e PP |
1 | = Babeltrace's version extra information |
2 | ||
3 | This directory contains files and a directory to add information to the | |
4 | version of a Babeltrace build. The CLI (`--version` option) and library | |
5 | can provide this information. | |
6 | ||
7 | The following directory and files are scanned at `src/common/version.i` | |
8 | generation time, which occurs at **every build**: | |
9 | ||
10 | `extra_version_name`:: | |
11 | If it exists, the first line of this file is the extra name of the | |
12 | custom version. | |
13 | ||
14 | `extra_version_description`:: | |
15 | If it exists, the file's contents is the extra description of the | |
16 | custom version. | |
17 | + | |
18 | This should contain a description of local modifications applied to the | |
19 | source tree. A distribution packager can use this file, for example, to | |
20 | specify what changes were applied locally. | |
21 | + | |
22 | All characters except alphanumeric ones, whitespaces, `.`, and `,` are | |
23 | replaced with `-`. | |
24 | ||
25 | `extra_patches`:: | |
26 | If it exists, this directory contains patch files applied to the | |
27 | source tree. | |
28 | + | |
29 | Each file name is included when generating `src/common/version.i`, | |
30 | except `README.adoc`. | |
31 | + | |
32 | All characters except alphanumeric ones, whitespaces, and `.` are | |
33 | replaced with `-`. |