1#!/bin/sh
2# SPDX-License-Identifier: GPL-2.0
3#
4# This scripts adds local version information from the version
5# control systems git, mercurial (hg) and subversion (svn).
6#
7# If something goes wrong, send a mail the kernel build mailinglist
8# (see MAINTAINERS) and CC Nico Schottelius
9# <nico-linuxsetlocalversion -at- schottelius.org>.
10#
11#
12
13usage() {
14	echo "Usage: $0 [srctree]" >&2
15	exit 1
16}
17
18srctree=.
19if test $# -gt 0; then
20	srctree=$1
21	shift
22fi
23if test $# -gt 0 -o ! -d "$srctree"; then
24	usage
25fi
26
27scm_version()
28{
29	local short
30	local tag
31	short=false
32
33	cd "$srctree"
34	if test "$1" = "--short"; then
35		short=true
36	fi
37
38	if test -n "$(git rev-parse --show-cdup 2>/dev/null)"; then
39		return
40	fi
41
42	if ! head=$(git rev-parse --verify HEAD 2>/dev/null); then
43		return
44	fi
45
46	# If a localversion*' file and the corresponding annotated tag exist,
47	# use it. This is the case in linux-next.
48	tag=${file_localversion#-}
49	tag=$(git describe --exact-match --match=$tag $tag 2>/dev/null)
50
51	# Otherwise, default to the annotated tag derived from KERNELVERSION.
52	#   mainline kernel:  6.2.0-rc5  ->  v6.2-rc5
53	#   stable kernel:    6.1.7      ->  v6.1.7
54	if [ -z "${tag}" ]; then
55		tag=v$(echo "${KERNELVERSION}" | sed -E 's/^([0-9]+\.[0-9]+)\.0(.*)$/\1\2/')
56	fi
57
58	# If we are at the tagged commit, we ignore it because the version is
59	# well-defined.
60	if [ -z "$(git describe --exact-match --match=$tag 2>/dev/null)" ]; then
61
62		# If only the short version is requested, don't bother
63		# running further git commands
64		if $short; then
65			echo "+"
66			return
67		fi
68		# If we are past the tagged commit, we pretty print it.
69		# (like 6.1.0-14595-g292a089d78d3)
70		if atag="$(git describe --match=$tag 2>/dev/null)"; then
71			echo "$atag" | awk -F- '{printf("-%05d", $(NF-1))}'
72		fi
73
74		# Add -g and exactly 12 hex chars.
75		printf '%s%s' -g "$(echo $head | cut -c1-12)"
76	fi
77
78	# Check for uncommitted changes.
79	# This script must avoid any write attempt to the source tree, which
80	# might be read-only.
81	# You cannot use 'git describe --dirty' because it tries to create
82	# .git/index.lock .
83	# First, with git-status, but --no-optional-locks is only supported in
84	# git >= 2.14, so fall back to git-diff-index if it fails. Note that
85	# git-diff-index does not refresh the index, so it may give misleading
86	# results.
87	# See git-update-index(1), git-diff-index(1), and git-status(1).
88	if {
89		git --no-optional-locks status -uno --porcelain 2>/dev/null ||
90		git diff-index --name-only HEAD
91	} | read dummy; then
92		printf '%s' -dirty
93	fi
94}
95
96collect_files()
97{
98	local file res=
99
100	for file; do
101		case "$file" in
102		*\~*)
103			continue
104			;;
105		esac
106		if test -e "$file"; then
107			res="$res$(cat "$file")"
108		fi
109	done
110	echo "$res"
111}
112
113if ! test -e include/config/auto.conf; then
114	echo "Error: kernelrelease not valid - run 'make prepare' to update it" >&2
115	exit 1
116fi
117
118if [ -z "${KERNELVERSION}" ]; then
119	echo "KERNELVERSION is not set" >&2
120	exit 1
121fi
122
123# localversion* files in the build and source directory
124file_localversion="$(collect_files localversion*)"
125if test ! "$srctree" -ef .; then
126	file_localversion="${file_localversion}$(collect_files "$srctree"/localversion*)"
127fi
128
129# version string from CONFIG_LOCALVERSION
130config_localversion=$(sed -n 's/^CONFIG_LOCALVERSION=\(.*\)$/\1/p' include/config/auto.conf)
131
132# scm version string if not at the kernel version tag or at the file_localversion
133if grep -q "^CONFIG_LOCALVERSION_AUTO=y$" include/config/auto.conf; then
134	# full scm version string
135	scm_version="$(scm_version)"
136elif [ "${LOCALVERSION+set}" != "set" ]; then
137	# If the variable LOCALVERSION is not set, append a plus
138	# sign if the repository is not in a clean annotated or
139	# signed tagged state (as git describe only looks at signed
140	# or annotated tags - git tag -a/-s).
141	#
142	# If the variable LOCALVERSION is set (including being set
143	# to an empty string), we don't want to append a plus sign.
144	scm_version="$(scm_version --short)"
145fi
146
147echo "${KERNELVERSION}${file_localversion}${config_localversion}${LOCALVERSION}${scm_version}"
148