xref: /openbmc/linux/scripts/setlocalversion (revision cf3ee3c8) 
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		# Is this git on svn?
83		if git config --get svn-remote.svn.url >/dev/null; then
84			printf -- '-svn%s' "$(git svn find-rev $head)"
85		fi
86
87		# Check for uncommitted changes.
88		# First, with git-status, but --no-optional-locks is only
89		# supported in git >= 2.14, so fall back to git-diff-index if
90		# it fails. Note that git-diff-index does not refresh the
91		# index, so it may give misleading results. See
92		# git-update-index(1), git-diff-index(1), and git-status(1).
93		if {
94			git --no-optional-locks status -uno --porcelain 2>/dev/null ||
95			git diff-index --name-only HEAD
96		} | grep -qvE '^(.. )?scripts/package'; then
97			printf '%s' -dirty
98		fi
99
100		# All done with git
101		return
102	fi
103
104	# Check for mercurial and a mercurial repo.
105	if test -d .hg && hgid=$(hg id 2>/dev/null); then
106		# Do we have an tagged version?  If so, latesttagdistance == 1
107		if [ "$(hg log -r . --template '{latesttagdistance}')" = "1" ]; then
108			id=$(hg log -r . --template '{latesttag}')
109			printf '%s%s' -hg "$id"
110		else
111			tag=$(printf '%s' "$hgid" | cut -d' ' -f2)
112			if [ -z "$tag" -o "$tag" = tip ]; then
113				id=$(printf '%s' "$hgid" | sed 's/[+ ].*//')
114				printf '%s%s' -hg "$id"
115			fi
116		fi
117
118		# Are there uncommitted changes?
119		# These are represented by + after the changeset id.
120		case "$hgid" in
121			*+|*+\ *) printf '%s' -dirty ;;
122		esac
123
124		# All done with mercurial
125		return
126	fi
127
128	# Check for svn and a svn repo.
129	if rev=$(LC_ALL=C svn info 2>/dev/null | grep '^Last Changed Rev'); then
130		rev=$(echo $rev | awk '{print $NF}')
131		printf -- '-svn%s' "$rev"
132
133		# All done with svn
134		return
135	fi
136}
137
138collect_files()
139{
140	local file res=
141
142	for file; do
143		case "$file" in
144		*\~*)
145			continue
146			;;
147		esac
148		if test -e "$file"; then
149			res="$res$(cat "$file")"
150		fi
151	done
152	echo "$res"
153}
154
155if $scm_only; then
156	if test ! -e .scmversion; then
157		res=$(scm_version)
158		echo "$res" >.scmversion
159	fi
160	exit
161fi
162
163if test -e include/config/auto.conf; then
164	. include/config/auto.conf
165else
166	echo "Error: kernelrelease not valid - run 'make prepare' to update it" >&2
167	exit 1
168fi
169
170# localversion* files in the build and source directory
171res="$(collect_files localversion*)"
172if test ! "$srctree" -ef .; then
173	res="$res$(collect_files "$srctree"/localversion*)"
174fi
175
176# CONFIG_LOCALVERSION and LOCALVERSION (if set)
177res="${res}${CONFIG_LOCALVERSION}${LOCALVERSION}"
178
179# scm version string if not at a tagged commit
180if test "$CONFIG_LOCALVERSION_AUTO" = "y"; then
181	# full scm version string
182	res="$res$(scm_version)"
183else
184	# append a plus sign if the repository is not in a clean
185	# annotated or signed tagged state (as git describe only
186	# looks at signed or annotated tags - git tag -a/-s) and
187	# LOCALVERSION= is not specified
188	if test "${LOCALVERSION+set}" != "set"; then
189		scm=$(scm_version --short)
190		res="$res${scm:++}"
191	fi
192fi
193
194echo "$res"
195