git-version-gen 7.9 KB

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