3 # SPDX-License-Identifier: GPL-2.0-only
5 # Copyright (C) 2023 EfficiOS, Inc.
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.
17 if test "${TOP_SRCDIR:-}" = ""; then
18 echo "$0: TOP_SRCDIR is not set" >&2
25 # Delete any stale "version.i.tmp" file.
28 if test ! -f version.i
&& test -f "$TOP_SRCDIR/include/version.i"; then
29 cp "$TOP_SRCDIR/include/version.i" version.i
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:
35 # "latest_tag"(-"number_of_commits_on_top")(-g"latest_commit_hash")(-dirty)
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".
41 # Use an explicit hash abbreviation length, to avoid local `core.abbrev`
42 # configurations leading to different results.
43 if test -r "$TOP_SRCDIR/bootstrap" && test -r "$TOP_SRCDIR/.git" &&
44 (command -v git
> /dev
/null
2>&1); then
45 GIT_VERSION_STR
="$(cd "$TOP_SRCDIR" && git describe --always --tags --dirty --abbrev=12)"
46 GIT_CURRENT_TAG
="$(cd "$TOP_SRCDIR" && (git describe --tags --exact-match --match="v
[0-9]*" HEAD || true) 2> /dev/null)"
47 echo "#define BT_VERSION_GIT \"$GIT_VERSION_STR\"" > version.i.tmp
49 if ! $GREP -- "-dirty" version.i.tmp
> /dev
/null
&&
50 test "x$GIT_CURRENT_TAG" != "x"; then
51 echo "#define BT_VERSION_GIT \"\"" > version.i.tmp
55 # If we don't have a "version.i.tmp" nor a "version.i", generate an empty
56 # string as a failover. If a "version.i" is present, for example when building
57 # from a distribution tarball, get the git_version using grep.
58 if test ! -f version.i.tmp
; then
59 if test -f version.i
; then
60 $GREP "^#define \bBT_VERSION_GIT\b.*" version.i
> version.i.tmp
62 echo '#define BT_VERSION_GIT ""' > version.i.tmp
67 # Fetch the BT_VERSION_EXTRA_NAME define from "version/extra_version_name" and output it
69 echo "#define BT_VERSION_EXTRA_NAME \"$($SED -n '1p' "$TOP_SRCDIR/version
/extra_version_name
" 2> /dev/null)\""
71 # Fetch the BT_VERSION_EXTRA_DESCRIPTION define from "version/extra_version_description",
72 # sanitize and format it with a sed script to replace all non-alpha-numeric values
73 # with "-" and join all lines by replacing "\n" with litteral string c-style "\n" and
74 # output it to "version.i.tmp".
75 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)\""
77 # Repeat the same logic for the "version/extra_patches" directory.
78 # Data fetched from "version/extra_patches" must be sanitized and
80 # The data is fetched using "find" with an ignore pattern for the README.adoc file.
81 # The sanitize step uses sed with a script to replace all
82 # non-alpha-numeric values, except " " (space), to "-".
83 # The formatting step uses sed with a script to join all lines
84 # by replacing "\n" with litteral string c-style "\n".
85 # shellcheck disable=SC2012
86 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)\""
89 # If we don't have a "version.i" or we have both files (version.i, version.i.tmp)
90 # and they are different, copy "version.i.tmp" over "version.i".
91 # This way the dependent targets are only rebuilt when the git version
92 # string or either one of extra version string change.
93 if test ! -f version.i ||
94 test x
"$(cat version.i.tmp)" != x
"$(cat version.i)"; then
95 mv -f version.i.tmp version.i