xref: /linux/scripts/setlocalversion (revision 2a73cce2dad3b6e0aa705b376bb736358b6b5e8e)
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 [--save-scmversion] [srctree]" >&2
15	exit 1
16}
17
18scm_only=false
19srctree=.
20if test "$1" = "--save-scmversion"; then
21	scm_only=true
22	shift
23fi
24if test $# -gt 0; then
25	srctree=$1
26	shift
27fi
28if test $# -gt 0 -o ! -d "$srctree"; then
29	usage
30fi
31
32scm_version()
33{
34	local short
35	short=false
36
37	cd "$srctree"
38	if test -e .scmversion; then
39		cat .scmversion
40		return
41	fi
42	if test "$1" = "--short"; then
43		short=true
44	fi
45
46	# Check for git and a git repo.
47	if test -z "$(git rev-parse --show-cdup 2>/dev/null)" &&
48	   head=$(git rev-parse --verify HEAD 2>/dev/null); then
49
50		# If we are at a tagged commit (like "v2.6.30-rc6"), we ignore
51		# it, because this version is defined in the top level Makefile.
52		if [ -z "$(git describe --exact-match 2>/dev/null)" ]; then
53
54			# If only the short version is requested, don't bother
55			# running further git commands
56			if $short; then
57				echo "+"
58				return
59			fi
60			# If we are past a tagged commit (like
61			# "v2.6.30-rc5-302-g72357d5"), we pretty print it.
62			#
63			# Ensure the abbreviated sha1 has exactly 12
64			# hex characters, to make the output
65			# independent of git version, local
66			# core.abbrev settings and/or total number of
67			# objects in the current repository - passing
68			# --abbrev=12 ensures a minimum of 12, and the
69			# awk substr() then picks the 'g' and first 12
70			# hex chars.
71			if atag="$(git describe --abbrev=12 2>/dev/null)"; then
72				echo "$atag" | awk -F- '{printf("-%05d-%s", $(NF-1),substr($(NF),0,13))}'
73
74			# If we don't have a tag at all we print -g{commitish},
75			# again using exactly 12 hex chars.
76			else
77				head="$(echo $head | cut -c1-12)"
78				printf '%s%s' -g $head
79			fi
80		fi
81
82		# Check for uncommitted changes.
83		# First, with git-status, but --no-optional-locks is only
84		# supported in git >= 2.14, so fall back to git-diff-index if
85		# it fails. Note that git-diff-index does not refresh the
86		# index, so it may give misleading results. See
87		# 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		} | grep -qvE '^(.. )?scripts/package'; then
92			printf '%s' -dirty
93		fi
94	fi
95}
96
97collect_files()
98{
99	local file res=
100
101	for file; do
102		case "$file" in
103		*\~*)
104			continue
105			;;
106		esac
107		if test -e "$file"; then
108			res="$res$(cat "$file")"
109		fi
110	done
111	echo "$res"
112}
113
114if $scm_only; then
115	if test ! -e .scmversion; then
116		res=$(scm_version)
117		echo "$res" >.scmversion
118	fi
119	exit
120fi
121
122if test -e include/config/auto.conf; then
123	. include/config/auto.conf
124else
125	echo "Error: kernelrelease not valid - run 'make prepare' to update it" >&2
126	exit 1
127fi
128
129# localversion* files in the build and source directory
130res="$(collect_files localversion*)"
131if test ! "$srctree" -ef .; then
132	res="$res$(collect_files "$srctree"/localversion*)"
133fi
134
135# CONFIG_LOCALVERSION and LOCALVERSION (if set)
136res="${res}${CONFIG_LOCALVERSION}${LOCALVERSION}"
137
138# scm version string if not at a tagged commit
139if test "$CONFIG_LOCALVERSION_AUTO" = "y"; then
140	# full scm version string
141	res="$res$(scm_version)"
142else
143	# append a plus sign if the repository is not in a clean
144	# annotated or signed tagged state (as git describe only
145	# looks at signed or annotated tags - git tag -a/-s) and
146	# LOCALVERSION= is not specified
147	if test "${LOCALVERSION+set}" != "set"; then
148		scm=$(scm_version --short)
149		res="$res${scm:++}"
150	fi
151fi
152
153echo "$res"
154