build-aux/git-version-gen

   1 #!/bin/sh
   2 # Print a version string.
   3 scriptversion=2022-07-09.08; # UTC
   4
   5 # Copyright (C) 2007-2024 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    --fallback VERSION
  92                       fallback version to use if \"git --version\" fails
  93
  94    --help             display this help and exit
  95    --version          output version information and exit
  96
  97 Send patches and bug reports to <bug-gnulib@gnu.org>."
  98
  99 prefix=v
 100 fallback=
 101
 102 while test $# -gt 0; do
 103   case $1 in
 104     --help) echo "$usage"; exit 0;;
 105     --version) echo "$version"; exit 0;;
 106     --prefix) shift; prefix=${1?};;
 107     --fallback) shift; fallback=${1?};;
 108     -*)
 109       echo "$0: Unknown option '$1'." >&2
 110       echo "$0: Try '--help' for more information." >&2
 111       exit 1;;
 112     *)
 113       if test "x$tarball_version_file" = x; then
 114         tarball_version_file="$1"
 115       elif test "x$tag_sed_script" = x; then
 116         tag_sed_script="$1"
 117       else
 118         echo "$0: extra non-option argument '$1'." >&2
 119         exit 1
 120       fi;;
 121   esac
 122   shift
 123 done
 124
 125 if test "x$tarball_version_file" = x; then
 126     echo "$usage"
 127     exit 1
 128 fi
 129
 130 tag_sed_script="${tag_sed_script:-s/x/x/}"
 131
 132 nl='
 133 '
 134
 135 # Avoid meddling by environment variable of the same name.
 136 v=
 137 v_from_git=
 138
 139 # First see if there is a tarball-only version file.
 140 # then try "git describe", then default.
 141 if test -f $tarball_version_file
 142 then
 143     v=`cat $tarball_version_file` || v=
 144     case $v in
 145         *$nl*) v= ;; # reject multi-line output
 146     esac
 147     test "x$v" = x \
 148         && echo "$0: WARNING: $tarball_version_file is damaged" 1>&2
 149 fi
 150
 151 if test "x$v" != x
 152 then
 153     : # use $v
 154 # Otherwise, if there is at least one git commit involving the working
 155 # directory, and "git describe" output looks sensible, use that to
 156 # derive a version string.
 157 elif test "`git log -1 --pretty=format:x . 2>&1`" = x \
 158     && v=`git describe --abbrev=4 --match="$prefix*" HEAD 2>/dev/null \
 159           || git describe --abbrev=4 HEAD 2>/dev/null` \
 160     && v=`printf '%s\n' "$v" | sed "$tag_sed_script"` \
 161     && case $v in
 162          $prefix[0-9]*) ;;
 163          *) (exit 1) ;;
 164        esac
 165 then
 166     # Is this a new git that lists number of commits since the last
 167     # tag or the previous older version that did not?
 168     #   Newer: v6.10-77-g0f8faeb
 169     #   Older: v6.10-g0f8faeb
 170     vprefix=`expr "X$v" : 'X\(.*\)-g[^-]*$'` || vprefix=$v
 171     case $vprefix in
 172         *-*) : git describe is probably okay three part flavor ;;
 173         *)
 174             : git describe is older two part flavor
 175             # Recreate the number of commits and rewrite such that the
 176             # result is the same as if we were using the newer version
 177             # of git describe.
 178             vtag=`echo "$v" | sed 's/-.*//'`
 179             commit_list=`git rev-list "$vtag"..HEAD 2>/dev/null` \
 180                 || { commit_list=failed;
 181                      echo "$0: WARNING: git rev-list failed" 1>&2; }
 182             numcommits=`echo "$commit_list" | wc -l`
 183             v=`echo "$v" | sed "s/\(.*\)-\(.*\)/\1-$numcommits-\2/"`;
 184             test "$commit_list" = failed && v=UNKNOWN
 185             ;;
 186     esac
 187
 188     # Change the penultimate "-" to ".", for version-comparing tools.
 189     # Remove the "g" to save a byte.
 190     v=`echo "$v" | sed 's/-\([^-]*\)-g\([^-]*\)$/.\1-\2/'`;
 191     v_from_git=1
 192 elif test "x$fallback" = x || git --version >/dev/null 2>&1; then
 193     v=UNKNOWN
 194 else
 195     v=$fallback
 196 fi
 197
 198 v=`echo "$v" |sed "s/^$prefix//"`
 199
 200 # Test whether to append the "-dirty" suffix only if the version
 201 # string we're using came from git.  I.e., skip the test if it's "UNKNOWN"
 202 # or if it came from .tarball-version.
 203 if test "x$v_from_git" != x; then
 204   # Don't declare a version "dirty" merely because a timestamp has changed.
 205   git update-index --refresh > /dev/null 2>&1
 206
 207   dirty=`exec 2>/dev/null;git diff-index --name-only HEAD` || dirty=
 208   case "$dirty" in
 209       '') ;;
 210       *) # Append the suffix only if there isn't one already.
 211           case $v in
 212             *-dirty) ;;
 213             *) v="$v-dirty" ;;
 214           esac ;;
 215   esac
 216 fi
 217
 218 # Omit the trailing newline, so that m4_esyscmd can use the result directly.
 219 printf %s "$v"
 220
 221 # Local variables:
 222 # eval: (add-hook 'before-save-hook 'time-stamp)
 223 # time-stamp-start: "scriptversion="
 224 # time-stamp-format: "%:y-%02m-%02d.%02H"
 225 # time-stamp-time-zone: "UTC0"
 226 # time-stamp-end: "; # UTC"
 227 # End: