version-ext.sh

#!/bin/sh

# This script outputs additional MPFR version information for a
# Git working tree (Git branch or "(none)", total commit count,
# commit id, and whether the current HEAD is modified). It is
# called in tests/Makefile.am for "make check", but may be used
# by other tools that need such information (other tests may be
# needed; see tests/Makefile.am as an example of use).
# Note that this does not replace version information found in
# the VERSION file, which may still need to be output in addition
# to the output of this script.

set -e

if [ "x`git rev-parse --is-inside-work-tree 2> /dev/null`" != xtrue ]; then
  echo "$0: This script should be executed from a Git working tree." >&2
  exit 1
fi

# Normally passed by tests/Makefile.am with "GREP=$(GREP) SED=$(SED)".
GREP=${GREP:-grep}
SED=${SED:-sed}

# Note: for the branch detection, in the case of a detached HEAD state,
# the commit may appear in multiple branches, i.e. which diverge after
# the commit; thus we exclude branches created after this commit, based
# on <branch>-root tags (such a tag should be added by the user when
# creating a branch, so that "git diff <branch>-root" shows commits done
# in the branch since its creation, etc.).

git tag --contains | $SED -n 's/-root$//p' > excluded-branches
gitb=`git branch --format='%(refname:short)' --contains | \
        $SED 's,(HEAD detached at origin/\(.*\)),\1,' | \
        $GREP -v '^(' | $GREP -v -F -f excluded-branches -x || true`
rm excluded-branches

# If $gitb contains multiple branches (say, A and B), this may be caused
# by a branch B that was merged into a branch A while it was in sync with
# branch A, i.e. before additional commits to branch A. In such a case,
# a merge commit isn't even generated, and the status is unfortunately
# ambiguous. In order to avoid this issue, the user may want to delete
# the local branch B (which is no longer needed). But we need to handle
# this situation in case it occurs. In practice, branch A will probably
# be the master branch, so let us handle only this case by assuming that
# the expected branch is master: if "master" appears in $gitb, select it.
#
# This is not ideal, though. For instance, in one checks out a branch B
# that was merged into master, one would rather want to see the version
# information as being from branch B rather than master, because at that
# time, this branch hadn't been merged into master yet. A workaround
# could be to replace the branch by a tag whose name as a some specific
# format, and handle that in this script; an advantage would be that the
# merged branch would be deleted as generally recommended.

[ "x`echo "$gitb" | $GREP '^master$'`" = x ] || gitb=master

gitc=`git rev-list --count HEAD`
gith=`git rev-parse --short HEAD`
gitm=`git update-index -q --refresh; git diff-index --name-only HEAD`
echo "${gitb:-(none)}-$gitc-$gith${gitm:+ (modified)}"

# References:
#   https://stackoverflow.com/q/3882838/3782797
#   https://stackoverflow.com/a/3899339/3782797
#     for the "git diff-index --name-only HEAD" solution, but this
#     is not sufficient, because autogen.sh modifies the "INSTALL"
#     and "doc/texinfo.tex" files (due to "autoreconf -f -i"), and
#     restores them. On needs:
#   https://stackoverflow.com/q/3882838/3782797#comment121636904_3899339
#     suggesting "git update-index -q --refresh" first.