freebsd-dev/scripts/make_gitrev.sh
Arvind Sankar 59415fc9fb Add zfs_gitrev.h to the distributed sources
Commit 109d2c9310 ("Move zfs_gitrev.h to build directory") stopped
distributing zfs_gitrev.h, as it is a generated file. Add it back, with
some changes in behavior.

Change the logic for gitrev as follows
- if the source tree is a git repository, the behavior for build is
  unchanged. For make dist, append -dist to the git tag in the
  distributed version of zfs_gitrev.h.
- otherwise, check if the source tree contains zfs_gitrev.h, and use it
  if so, falling back to "unknown" if it doesn't exist.
- clean it only in make maintainer-clean, so we don't remove it from the
  source tree on make clean or make distclean.

This allows disted sources to track what git tag they originally came
from, with the -dist suffix indicating that the code wasn't built
directly from git and so might contain additional changes beyond the git
tag.

Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Reviewed-by: Eli Schwartz <eschwartz@archlinux.org>
Signed-off-by: Arvind Sankar <nivedita@alum.mit.edu>
Closes #10595
2020-07-22 10:00:40 -07:00

79 lines
2.0 KiB
Bash
Executable File

#!/bin/sh
#
# CDDL HEADER START
#
# This file and its contents are supplied under the terms of the
# Common Development and Distribution License ("CDDL"), version 1.0.
# You may only use this file in accordance with the terms of version
# 1.0 of the CDDL.
#
# A full copy of the text of the CDDL should have accompanied this
# source. A copy of the CDDL is also available via the Internet at
# http://www.illumos.org/license/CDDL.
#
# CDDL HEADER END
#
# Copyright (c) 2018 by Delphix. All rights reserved.
# Copyright (c) 2018 by Matthew Thode. All rights reserved.
#
# Generate zfs_gitrev.h. Note that we need to do this for every
# invocation of `make`, including for incremental builds. Therefore we
# can't use a zfs_gitrev.h.in file which would be processed only when
# `configure` is run.
#
set -e -u
dist=no
distdir=.
while getopts D: flag
do
case $flag in
\?) echo "Usage: $0 [-D distdir] [file]" >&2; exit 1;;
D) dist=yes; distdir=${OPTARG};;
esac
done
shift $((OPTIND - 1))
top_srcdir="$(dirname "$0")/.."
GITREV="${1:-include/zfs_gitrev.h}"
# GITREV should be a relative path (relative to top_builddir or distdir)
case "${GITREV}" in
/*) echo "Error: ${GITREV} should be a relative path" >&2
exit 1;;
esac
ZFS_GITREV=$({ cd "${top_srcdir}" &&
git describe --always --long --dirty 2>/dev/null; } || :)
if [ "x${ZFS_GITREV}" = x ]
then
# If the source directory is not a git repository, check if the file
# already exists (in the source)
if [ -f "${top_srcdir}/${GITREV}" ]
then
ZFS_GITREV="$(sed -n \
'1s/^#define[[:blank:]]ZFS_META_GITREV "\([^"]*\)"$/\1/p' \
"${top_srcdir}/${GITREV}")"
fi
elif [ ${dist} = yes ]
then
# Append -dist when creating distributed sources from a git repository
ZFS_GITREV="${ZFS_GITREV}-dist"
fi
ZFS_GITREV=${ZFS_GITREV:-unknown}
GITREVTMP="${GITREV}~"
printf '#define\tZFS_META_GITREV "%s"\n' "${ZFS_GITREV}" >"${GITREVTMP}"
GITREV="${distdir}/${GITREV}"
if cmp -s "${GITREV}" "${GITREVTMP}"
then
rm -f "${GITREVTMP}"
else
mv -f "${GITREVTMP}" "${GITREV}"
fi