Debian Codegraph @

build-aux/git-version-gen

raw
1 #!/bin/sh
2 # Print a version string.
3 scriptversion=2022-07-09.08; # UTC
4
5 # Copyright (C) 2007-2023 Free Software Foundation, Inc.
6 #
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
11 #
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
16 #
17 # You should have received a copy of the GNU General Public License
18 # along with this program. If not, see <https://www.gnu.org/licenses/>.
19
20 # This script is derived from GIT-VERSION-GEN from GIT: https://git-scm.com/.
21 # It may be run two ways:
22 # - from a git repository in which the "git describe" command below
23 # produces useful output (thus requiring at least one signed tag)
24 # - from a non-git-repo directory containing a .tarball-version file, which
25 # presumes this script is invoked like "./git-version-gen .tarball-version".
26
27 # In order to use intra-version strings in your project, you will need two
28 # separate generated version string files:
29 #
30 # .tarball-version - present only in a distribution tarball, and not in
31 # a checked-out repository. Created with contents that were learned at
32 # the last time autoconf was run, and used by git-version-gen. Must not
33 # be present in either $(srcdir) or $(builddir) for git-version-gen to
34 # give accurate answers during normal development with a checked out tree,
35 # but must be present in a tarball when there is no version control system.
36 # Therefore, it cannot be used in any dependencies. GNUmakefile has
37 # hooks to force a reconfigure at distribution time to get the value
38 # correct, without penalizing normal development with extra reconfigures.
39 #
40 # .version - present in a checked-out repository and in a distribution
41 # tarball. Usable in dependencies, particularly for files that don't
42 # want to depend on config.h but do want to track version changes.
43 # Delete this file prior to any autoconf run where you want to rebuild
44 # files to pick up a version string change; and leave it stale to
45 # minimize rebuild time after unrelated changes to configure sources.
46 #
47 # As with any generated file in a VC'd directory, you should add
48 # /.version to .gitignore, so that you don't accidentally commit it.
49 # .tarball-version is never generated in a VC'd directory, so needn't
50 # be listed there.
51 #
52 # Use the following line in your configure.ac, so that $(VERSION) will
53 # automatically be up-to-date each time configure is run (and note that
54 # since configure.ac no longer includes a version string, Makefile rules
55 # should not depend on configure.ac for version updates).
56 #
57 # AC_INIT([GNU project],
58 # m4_esyscmd([build-aux/git-version-gen .tarball-version]),
59 # [bug-project@example])
60 #
61 # Then use the following lines in your Makefile.am, so that .version
62 # will be present for dependencies, and so that .version and
63 # .tarball-version will exist in distribution tarballs.
64 #
65 # EXTRA_DIST = $(top_srcdir)/.version
66 # BUILT_SOURCES = $(top_srcdir)/.version
67 # $(top_srcdir)/.version:
68 # echo '$(VERSION)' > $@-t
69 # mv $@-t $@
70 # dist-hook:
71 # echo '$(VERSION)' > $(distdir)/.tarball-version
72
73
74 me=$0
75
76 year=`expr "$scriptversion" : '\([^-]*\)'`
77 version="git-version-gen $scriptversion
78
79 Copyright (C) ${year} Free Software Foundation, Inc.
80 License GPLv3+: GNU GPL version 3 or later <https://gnu.org/licenses/gpl.html>.
81 This is free software: you are free to change and redistribute it.
82 There is NO WARRANTY, to the extent permitted by law."
83
84 usage="\
85 Usage: $me [OPTION]... \$srcdir/.tarball-version [TAG-NORMALIZATION-SED-SCRIPT]
86 Print a version string.
87
88 Options:
89
90 --prefix PREFIX prefix of git tags (default 'v')
91 --match pattern for git tags to match (default: '\$prefix*')
92 --fallback VERSION
93 fallback version to use if \"git --version\" fails
94
95 --help display this help and exit
96 --version output version information and exit
97
98 Send patches and bug reports to <[email protected]>."
99
100 prefix=v
101 fallback=
102
103 unset match
104 unset tag_sed_script
105
106 while test $# -gt 0; do
107 case $1 in
108 --help) echo "$usage"; exit 0;;
109 --version) echo "$version"; exit 0;;
110 --prefix) shift; prefix=${1?};;
111 --match) shift; match="$1";;
112 --fallback) shift; fallback=${1?};;
113 -*)
114 echo "$0: Unknown option '$1'." >&2
115 echo "$0: Try '--help' for more information." >&2
116 exit 1;;
117 *)
118 if test "x$tarball_version_file" = x; then
119 tarball_version_file="$1"
120 elif test "x$tag_sed_script" = x; then
121 tag_sed_script="$1"
122 else
123 echo "$0: extra non-option argument '$1'." >&2
124 exit 1
125 fi;;
126 esac
127 shift
128 done
129
130 if test "x$tarball_version_file" = x; then
131 echo "$usage"
132 exit 1
133 fi
134
135 match="${match:-$prefix*}"
136 tag_sed_script="${tag_sed_script:-s/x/x/}"
137
138 nl='
139 '
140
141 # Avoid meddling by environment variable of the same name.
142 v=
143 v_from_git=
144
145 # First see if there is a tarball-only version file.
146 # then try "git describe", then default.
147 if test -f $tarball_version_file
148 then
149 v=`cat $tarball_version_file` || v=
150 case $v in
151 *$nl*) v= ;; # reject multi-line output
152 esac
153 test "x$v" = x \
154 && echo "$0: WARNING: $tarball_version_file is damaged" 1>&2
155 fi
156
157 if test "x$v" != x
158 then
159 : # use $v
160 # Otherwise, if there is at least one git commit involving the working
161 # directory, and "git describe" output looks sensible, use that to
162 # derive a version string.
163 elif test "`git log -1 --pretty=format:x . 2>&1`" = x \
164 && v=`git describe --abbrev=4 --match="$match" HEAD 2>/dev/null \
165 || git describe --abbrev=4 HEAD 2>/dev/null` \
166 && v=`printf '%s\n' "$v" | sed "$tag_sed_script"` \
167 && case $v in
168 $prefix[0-9]*) ;;
169 *) (exit 1) ;;
170 esac
171 then
172 # Is this a new git that lists number of commits since the last
173 # tag or the previous older version that did not?
174 # Newer: v6.10-77-g0f8faeb
175 # Older: v6.10-g0f8faeb
176 vprefix=`expr "X$v" : 'X\(.*\)-g[^-]*$'` || vprefix=$v
177 case $vprefix in
178 *-*) : git describe is probably okay three part flavor ;;
179 *)
180 : git describe is older two part flavor
181 # Recreate the number of commits and rewrite such that the
182 # result is the same as if we were using the newer version
183 # of git describe.
184 vtag=`echo "$v" | sed 's/-.*//'`
185 commit_list=`git rev-list "$vtag"..HEAD 2>/dev/null` \
186 || { commit_list=failed;
187 echo "$0: WARNING: git rev-list failed" 1>&2; }
188 numcommits=`echo "$commit_list" | wc -l`
189 v=`echo "$v" | sed "s/\(.*\)-\(.*\)/\1-$numcommits-\2/"`;
190 test "$commit_list" = failed && v=UNKNOWN
191 ;;
192 esac
193
194 # Change the penultimate "-" to ".", for version-comparing tools.
195 # Remove the "g" to save a byte.
196 v=`echo "$v" | sed 's/-\([^-]*\)-g\([^-]*\)$/.\1-\2/'`;
197 v_from_git=1
198 elif test "x$fallback" = x || git --version >/dev/null 2>&1; then
199 v=UNKNOWN
200 else
201 v=$fallback
202 fi
203
204 v=`echo "$v" |sed "s/^$prefix//"`
205
206 # Test whether to append the "-dirty" suffix only if the version
207 # string we're using came from git. I.e., skip the test if it's "UNKNOWN"
208 # or if it came from .tarball-version.
209 if test "x$v_from_git" != x; then
210 # Don't declare a version "dirty" merely because a timestamp has changed.
211 git update-index --refresh > /dev/null 2>&1
212
213 dirty=`exec 2>/dev/null;git diff-index --name-only HEAD` || dirty=
214 case "$dirty" in
215 '') ;;
216 *) # Append the suffix only if there isn't one already.
217 case $v in
218 *-dirty) ;;
219 *) v="$v-dirty" ;;
220 esac ;;
221 esac
222 fi
223
224 # Omit the trailing newline, so that m4_esyscmd can use the result directly.
225 printf %s "$v"
226
227 # Local variables:
228 # eval: (add-hook 'before-save-hook 'time-stamp)
229 # time-stamp-start: "scriptversion="
230 # time-stamp-format: "%:y-%02m-%02d.%02H"
231 # time-stamp-time-zone: "UTC0"
232 # time-stamp-end: "; # UTC"
233 # End: