Commit | Line | Data |
---|---|---|
90eb0380 SM |
1 | #!/usr/bin/env sh |
2 | # | |
3 | # SPDX-License-Identifier: GPL-2.0-only | |
4 | # | |
5 | # Copyright (C) 2023 EfficiOS, Inc. | |
6 | ||
7 | # This file generates an include file that contains the git version | |
8 | # string of the current branch, it must be continuously updated when | |
9 | # we build in the git repo and shipped in dist tarballs to reflect the | |
10 | # status of the tree when it was generated. If the tree is clean and | |
11 | # the current commit is a tag starting with "v", consider this a | |
12 | # release version and set an empty git version. | |
13 | ||
14 | set -o nounset | |
3ccee65c | 15 | set -o errexit |
90eb0380 SM |
16 | |
17 | if test "${TOP_SRCDIR:-}" = ""; then | |
18 | echo "$0: TOP_SRCDIR is not set" >&2 | |
19 | exit 1 | |
20 | fi | |
21 | ||
22 | GREP=${GREP:-grep} | |
23 | SED=${SED:-sed} | |
24 | ||
25 | # Delete any stale "version.i.tmp" file. | |
26 | rm -f version.i.tmp | |
27 | ||
385ba368 | 28 | if test ! -f version.i && test -f "$TOP_SRCDIR/include/version.i"; then |
90eb0380 SM |
29 | cp "$TOP_SRCDIR/include/version.i" version.i |
30 | fi | |
31 | ||
32 | # If "bootstrap" and ".git" exists in the top source directory and the git | |
33 | # executable is available, get the current git version string in the form: | |
34 | # | |
35 | # "latest_tag"(-"number_of_commits_on_top")(-g"latest_commit_hash")(-dirty) | |
36 | # | |
37 | # And store it in "version.i.tmp", if the current commit is tagged, the tag | |
38 | # starts with "v" and the tree is clean, consider this a release version and | |
39 | # overwrite the git version with an empty string in "version.i.tmp". | |
385ba368 | 40 | if test -r "$TOP_SRCDIR/bootstrap" && test -r "$TOP_SRCDIR/.git" && |
3c98cc77 | 41 | (command -v git > /dev/null 2>&1); then |
3ccee65c | 42 | GIT_VERSION_STR="$(cd "$TOP_SRCDIR" && (git describe --tags --dirty || true))" |
385ba368 | 43 | GIT_CURRENT_TAG="$(cd "$TOP_SRCDIR" && (git describe --tags --exact-match --match="v[0-9]*" HEAD || true) 2> /dev/null)" |
90eb0380 SM |
44 | echo "#define BT_VERSION_GIT \"$GIT_VERSION_STR\"" > version.i.tmp |
45 | ||
46 | if ! $GREP -- "-dirty" version.i.tmp > /dev/null && | |
47 | test "x$GIT_CURRENT_TAG" != "x"; then | |
48 | echo "#define BT_VERSION_GIT \"\"" > version.i.tmp | |
49 | fi | |
50 | fi | |
51 | ||
52 | # If we don't have a "version.i.tmp" nor a "version.i", generate an empty | |
53 | # string as a failover. If a "version.i" is present, for example when building | |
54 | # from a distribution tarball, get the git_version using grep. | |
55 | if test ! -f version.i.tmp; then | |
56 | if test -f version.i; then | |
57 | $GREP "^#define \bBT_VERSION_GIT\b.*" version.i > version.i.tmp | |
58 | else | |
59 | echo '#define BT_VERSION_GIT ""' > version.i.tmp | |
60 | fi | |
61 | fi | |
62 | ||
385ba368 SM |
63 | { |
64 | # Fetch the BT_VERSION_EXTRA_NAME define from "version/extra_version_name" and output it | |
65 | # to "version.i.tmp". | |
66 | echo "#define BT_VERSION_EXTRA_NAME \"$($SED -n '1p' "$TOP_SRCDIR/version/extra_version_name" 2> /dev/null)\"" | |
90eb0380 | 67 | |
385ba368 SM |
68 | # Fetch the BT_VERSION_EXTRA_DESCRIPTION define from "version/extra_version_description", |
69 | # sanitize and format it with a sed script to replace all non-alpha-numeric values | |
70 | # with "-" and join all lines by replacing "\n" with litteral string c-style "\n" and | |
71 | # output it to "version.i.tmp". | |
72 | echo "#define BT_VERSION_EXTRA_DESCRIPTION \"$($SED -E ':a ; N ; $!ba ; s/[^a-zA-Z0-9 \n\t\.,]/-/g ; s/\r{0,1}\n/\\n/g' "$TOP_SRCDIR/version/extra_version_description" 2> /dev/null)\"" | |
90eb0380 | 73 | |
385ba368 SM |
74 | # Repeat the same logic for the "version/extra_patches" directory. |
75 | # Data fetched from "version/extra_patches" must be sanitized and | |
76 | # formatted. | |
77 | # The data is fetched using "find" with an ignore pattern for the README.adoc file. | |
78 | # The sanitize step uses sed with a script to replace all | |
79 | # non-alpha-numeric values, except " " (space), to "-". | |
80 | # The formatting step uses sed with a script to join all lines | |
81 | # by replacing "\n" with litteral string c-style "\n". | |
82 | # shellcheck disable=SC2012 | |
83 | echo "#define BT_VERSION_EXTRA_PATCHES \"$(ls -1 "$TOP_SRCDIR/version/extra_patches" | $GREP -v '^README.adoc' | $SED -E ':a ; N ; $!ba ; s/[^a-zA-Z0-9 \n\t\.]/-/g ; s/\r{0,1}\n/\\n/g' 2> /dev/null)\"" | |
84 | } >> version.i.tmp | |
90eb0380 SM |
85 | |
86 | # If we don't have a "version.i" or we have both files (version.i, version.i.tmp) | |
87 | # and they are different, copy "version.i.tmp" over "version.i". | |
88 | # This way the dependent targets are only rebuilt when the git version | |
89 | # string or either one of extra version string change. | |
90 | if test ! -f version.i || | |
385ba368 | 91 | test x"$(cat version.i.tmp)" != x"$(cat version.i)"; then |
0416e340 | 92 | mv -f version.i.tmp version.i |
90eb0380 SM |
93 | fi |
94 | ||
95 | rm -f version.i.tmp |