6d7144665dfbfb9f607fd0728c46018b946e8c5f
[pspp] / build-aux / git-version-gen
1 #!/bin/sh
2 # Print a version string.
3 scriptversion=2011-07-31.12; # UTC
4
5 # Copyright (C) 2007-2011 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 <http://www.gnu.org/licenses/>.
19
20 # This script is derived from GIT-VERSION-GEN from GIT: http://git.or.cz/.
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 # It is probably wise to add these two files to .gitignore, so that you
48 # don't accidentally commit either generated file.
49 #
50 # Use the following line in your configure.ac, so that $(VERSION) will
51 # automatically be up-to-date each time configure is run (and note that
52 # since configure.ac no longer includes a version string, Makefile rules
53 # should not depend on configure.ac for version updates).
54 #
55 # AC_INIT([GNU project],
56 #         m4_esyscmd([build-aux/git-version-gen .tarball-version]),
57 #         [bug-project@example])
58 #
59 # Then use the following lines in your Makefile.am, so that .version
60 # will be present for dependencies, and so that .version and
61 # .tarball-version will exist in distribution tarballs.
62 #
63 # EXTRA_DIST = $(top_srcdir)/.version
64 # BUILT_SOURCES = $(top_srcdir)/.version
65 # $(top_srcdir)/.version:
66 #       echo $(VERSION) > $@-t && mv $@-t $@
67 # dist-hook:
68 #       echo $(VERSION) > $(distdir)/.tarball-version
69
70 case $# in
71     1|2) ;;
72     *) echo 1>&2 "Usage: $0 \$srcdir/.tarball-version" \
73          '[TAG-NORMALIZATION-SED-SCRIPT]'
74        exit 1;;
75 esac
76
77 tarball_version_file=$1
78 tag_sed_script="${2:-s/x/x/}"
79 nl='
80 '
81
82 # Avoid meddling by environment variable of the same name.
83 v=
84 v_from_git=
85
86 # First see if there is a tarball-only version file.
87 # then try "git describe", then default.
88 if test -f $tarball_version_file
89 then
90     v=`cat $tarball_version_file` || v=
91     case $v in
92         *$nl*) v= ;; # reject multi-line output
93         [0-9]*) ;;
94         *) v= ;;
95     esac
96     test -z "$v" \
97         && echo "$0: WARNING: $tarball_version_file is missing or damaged" 1>&2
98 fi
99
100 if test -n "$v"
101 then
102     : # use $v
103 # Otherwise, if there is at least one git commit involving the working
104 # directory, and "git describe" output looks sensible, use that to
105 # derive a version string.
106 elif test "`git log -1 --pretty=format:x . 2>&1`" = x \
107     && v=`git describe --abbrev=4 --match='v*' HEAD 2>/dev/null \
108           || git describe --abbrev=4 HEAD 2>/dev/null` \
109     && v=`printf '%s\n' "$v" | sed "$tag_sed_script"` \
110     && case $v in
111          v[0-9]*) ;;
112          *) (exit 1) ;;
113        esac
114 then
115     # Is this a new git that lists number of commits since the last
116     # tag or the previous older version that did not?
117     #   Newer: v6.10-77-g0f8faeb
118     #   Older: v6.10-g0f8faeb
119     case $v in
120         *-*-*) : git describe is okay three part flavor ;;
121         *-*)
122             : git describe is older two part flavor
123             # Recreate the number of commits and rewrite such that the
124             # result is the same as if we were using the newer version
125             # of git describe.
126             vtag=`echo "$v" | sed 's/-.*//'`
127             commit_list=`git rev-list "$vtag"..HEAD 2>/dev/null` \
128                 || { commit_list=failed;
129                      echo "$0: WARNING: git rev-list failed" 1>&2; }
130             numcommits=`echo "$commit_list" | wc -l`
131             v=`echo "$v" | sed "s/\(.*\)-\(.*\)/\1-$numcommits-\2/"`;
132             test "$commit_list" = failed && v=UNKNOWN
133             ;;
134     esac
135
136     # Change the first '-' to a '.', so version-comparing tools work properly.
137     # Remove the "g" in git describe's output string, to save a byte.
138     v=`echo "$v" | sed 's/-/./;s/\(.*\)-g/\1-/'`;
139     v_from_git=1
140 else
141     v=UNKNOWN
142 fi
143
144 v=`echo "$v" |sed 's/^v//'`
145
146 # Test whether to append the "-dirty" suffix only if the version
147 # string we're using came from git.  I.e., skip the test if it's "UNKNOWN"
148 # or if it came from .tarball-version.
149 if test -n "$v_from_git"; then
150   # Don't declare a version "dirty" merely because a time stamp has changed.
151   git update-index --refresh > /dev/null 2>&1
152
153   dirty=`exec 2>/dev/null;git diff-index --name-only HEAD` || dirty=
154   case "$dirty" in
155       '') ;;
156       *) # Append the suffix only if there isn't one already.
157           case $v in
158             *-dirty) ;;
159             *) v="$v-dirty" ;;
160           esac ;;
161   esac
162 fi
163
164 # Omit the trailing newline, so that m4_esyscmd can use the result directly.
165 echo "$v" | tr -d "$nl"
166
167 # Local variables:
168 # eval: (add-hook 'write-file-hooks 'time-stamp)
169 # time-stamp-start: "scriptversion="
170 # time-stamp-format: "%:y-%02m-%02d.%02H"
171 # time-stamp-time-zone: "UTC"
172 # time-stamp-end: "; # UTC"
173 # End: