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