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