Fix typos
[babeltrace.git] / src / gen-version-i.sh
CommitLineData
90eb0380
SM
1#!/usr/bin/env sh
2#
53118ba6 3# SPDX-FileCopyrightText: 2023 EfficiOS, Inc.
90eb0380 4# SPDX-License-Identifier: GPL-2.0-only
90eb0380
SM
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
13set -o nounset
3ccee65c 14set -o errexit
90eb0380
SM
15
16if test "${TOP_SRCDIR:-}" = ""; then
17 echo "$0: TOP_SRCDIR is not set" >&2
18 exit 1
19fi
20
21GREP=${GREP:-grep}
22SED=${SED:-sed}
23
24# Delete any stale "version.i.tmp" file.
ed615696 25rm -f common/version.i.tmp
90eb0380 26
ed615696
MJ
27if test ! -f common/version.i && test -f "$TOP_SRCDIR/include/version.i"; then
28 cp "$TOP_SRCDIR/include/version.i" common/version.i
90eb0380
SM
29fi
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".
4862d1ac
SM
39#
40# Use an explicit hash abbreviation length, to avoid local `core.abbrev`
41# configurations leading to different results.
385ba368 42if test -r "$TOP_SRCDIR/bootstrap" && test -r "$TOP_SRCDIR/.git" &&
3c98cc77 43 (command -v git > /dev/null 2>&1); then
ccc24971 44 GIT_VERSION_STR="$(cd "$TOP_SRCDIR" && git describe --always --tags --dirty --abbrev=12)"
385ba368 45 GIT_CURRENT_TAG="$(cd "$TOP_SRCDIR" && (git describe --tags --exact-match --match="v[0-9]*" HEAD || true) 2> /dev/null)"
ed615696 46 echo "#define BT_VERSION_GIT \"$GIT_VERSION_STR\"" > common/version.i.tmp
90eb0380 47
ed615696 48 if ! $GREP -- "-dirty" common/version.i.tmp > /dev/null &&
90eb0380 49 test "x$GIT_CURRENT_TAG" != "x"; then
ed615696 50 echo "#define BT_VERSION_GIT \"\"" > common/version.i.tmp
90eb0380
SM
51 fi
52fi
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.
ed615696
MJ
57if 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
90eb0380 60 else
ed615696 61 echo '#define BT_VERSION_GIT ""' > common/version.i.tmp
90eb0380
SM
62 fi
63fi
64
385ba368
SM
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)\""
90eb0380 69
385ba368
SM
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
e7401568 72 # with "-" and join all lines by replacing "\n" with literal string c-style "\n" and
385ba368
SM
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)\""
90eb0380 75
385ba368
SM
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
e7401568 83 # by replacing "\n" with literal string c-style "\n".
385ba368
SM
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)\""
ed615696 86} >> common/version.i.tmp
90eb0380
SM
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.
ed615696
MJ
92if 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
90eb0380
SM
95fi
96
ed615696 97rm -f common/version.i.tmp
This page took 0.032592 seconds and 4 git commands to generate.