linux-yocto/scripts/setlocalversion
Masahiro Yamada ffaf62a805 scripts/setlocalversion: add more comments to -dirty flag detection
This script stumbled on the read-only source tree over again:

 - a2bb90a08c ("kbuild: fix delay in setlocalversion on readonly
   source")

 - cdf2bc632e ("scripts/setlocalversion on write-protected source
   tree")

 - 8ef14c2c41 ("Revert "scripts/setlocalversion: git: Make -dirty
   check more robust"")

 - ff64dd4857 ("scripts/setlocalversion: Improve -dirty check with
   git-status --no-optional-locks")

Add comments to clarify that this script should never ever try to write
to the source tree.

'git describe --dirty' might look as a simple solution for appending
the -dirty string, but we cannot use it because it creates the
.git/index.lock file.

Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Reviewed-by: Nico Schottelius <nico-linuxsetlocalversion@schottelius.org>
2021-05-27 04:01:51 +09:00

3.8 KiB
Executable File

#!/bin/sh

SPDX-License-Identifier: GPL-2.0

This scripts adds local version information from the version

control systems git, mercurial (hg) and subversion (svn).

If something goes wrong, send a mail the kernel build mailinglist

(see MAINTAINERS) and CC Nico Schottelius

<nico-linuxsetlocalversion -at- schottelius.org>.

usage() { echo "Usage: $0 [--save-scmversion] [srctree]" >&2 exit 1 }

scm_only=false srctree=. if test "$1" = "--save-scmversion"; then scm_only=true shift fi if test $# -gt 0; then srctree=$1 shift fi if test $# -gt 0 -o ! -d "$srctree"; then usage fi

scm_version() { local short short=false

cd "$srctree"
if test -e .scmversion; then
	cat .scmversion
	return
fi
if test "$1" = "--short"; then
	short=true
fi

# Check for git and a git repo.
if test -z "$(git rev-parse --show-cdup 2>/dev/null)" &&
   head=$(git rev-parse --verify HEAD 2>/dev/null); then

	# If we are at a tagged commit (like "v2.6.30-rc6"), we ignore
	# it, because this version is defined in the top level Makefile.
	if [ -z "$(git describe --exact-match 2>/dev/null)" ]; then

		# If only the short version is requested, don't bother
		# running further git commands
		if $short; then
			echo "+"
			return
		fi
		# If we are past a tagged commit (like
		# "v2.6.30-rc5-302-g72357d5"), we pretty print it.
		#
		# Ensure the abbreviated sha1 has exactly 12
		# hex characters, to make the output
		# independent of git version, local
		# core.abbrev settings and/or total number of
		# objects in the current repository - passing
		# --abbrev=12 ensures a minimum of 12, and the
		# awk substr() then picks the 'g' and first 12
		# hex chars.
		if atag="$(git describe --abbrev=12 2>/dev/null)"; then
			echo "$atag" | awk -F- '{printf("-%05d-%s", $(NF-1),substr($(NF),0,13))}'

		# If we don't have a tag at all we print -g{commitish},
		# again using exactly 12 hex chars.
		else
			head="$(echo $head | cut -c1-12)"
			printf '%s%s' -g $head
		fi
	fi

	# Check for uncommitted changes.
	# This script must avoid any write attempt to the source tree,
	# which might be read-only.
	# You cannot use 'git describe --dirty' because it tries to
	# create .git/index.lock .
	# First, with git-status, but --no-optional-locks is only
	# supported in git >= 2.14, so fall back to git-diff-index if
	# it fails. Note that git-diff-index does not refresh the
	# index, so it may give misleading results. See
	# git-update-index(1), git-diff-index(1), and git-status(1).
	if {
		git --no-optional-locks status -uno --porcelain 2>/dev/null ||
		git diff-index --name-only HEAD
	} | read dummy; then
		printf '%s' -dirty
	fi
fi

}

collect_files() { local file res=

for file; do
	case "$file" in
	*\~*)
		continue
		;;
	esac
	if test -e "$file"; then
		res="$res$(cat "$file")"
	fi
done
echo "$res"

}

if $scm_only; then if test ! -e .scmversion; then res=$(scm_version) echo "$res" >.scmversion fi exit fi

if test -e include/config/auto.conf; then . include/config/auto.conf else echo "Error: kernelrelease not valid - run 'make prepare' to update it" >&2 exit 1 fi

localversion* files in the build and source directory

res="$(collect_files localversion*)" if test ! "$srctree" -ef .; then res="$res$(collect_files "$srctree"/localversion*)" fi

CONFIG_LOCALVERSION and LOCALVERSION (if set)

res="${res}${CONFIG_LOCALVERSION}${LOCALVERSION}"

scm version string if not at a tagged commit

if test "$CONFIG_LOCALVERSION_AUTO" = "y"; then # full scm version string res="$res$(scm_version)" else # append a plus sign if the repository is not in a clean # annotated or signed tagged state (as git describe only # looks at signed or annotated tags - git tag -a/-s) and # LOCALVERSION= is not specified if test "${LOCALVERSION+set}" != "set"; then scm=$(scm_version --short) res="$res${scm:++}" fi fi

echo "$res"