blob: af4754a35e665230badde79e043c172eeef03325 [file] [log] [blame]
Rene Scharfe117a93d2006-01-04 20:42:03 +01001#!/bin/sh
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01002# SPDX-License-Identifier: GPL-2.0
Nico Schottelius33252572009-05-16 14:00:56 +02003#
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#
Ryan Andersonaaebf432005-07-31 04:57:49 -040012
Rene Scharfe117a93d2006-01-04 20:42:03 +010013usage() {
Michal Marekb003afe2010-07-15 10:36:37 +020014 echo "Usage: $0 [--save-scmversion] [srctree]" >&2
Rene Scharfe117a93d2006-01-04 20:42:03 +010015 exit 1
Ryan Andersonaaebf432005-07-31 04:57:49 -040016}
17
Michal Marek09155122010-06-17 15:14:58 +020018scm_only=false
19srctree=.
Michal Marekb003afe2010-07-15 10:36:37 +020020if test "$1" = "--save-scmversion"; then
Michal Marek09155122010-06-17 15:14:58 +020021 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
Ryan Andersonaaebf432005-07-31 04:57:49 -040031
Michal Marek09155122010-06-17 15:14:58 +020032scm_version()
33{
Michał Górny6dc0c2f2010-07-18 10:26:40 +020034 local short
35 short=false
Nico Schottelius33252572009-05-16 14:00:56 +020036
Michal Marek09155122010-06-17 15:14:58 +020037 cd "$srctree"
38 if test -e .scmversion; then
Michał Górny6dc0c2f2010-07-18 10:26:40 +020039 cat .scmversion
Michal Marek09155122010-06-17 15:14:58 +020040 return
41 fi
42 if test "$1" = "--short"; then
43 short=true
44 fi
Nico Schottelius33252572009-05-16 14:00:56 +020045
Michal Marek09155122010-06-17 15:14:58 +020046 # Check for git and a git repo.
Franck Bui-Huu7593e092013-12-02 16:34:29 +010047 if test -z "$(git rev-parse --show-cdup 2>/dev/null)" &&
Rasmus Villemoes548b8b52020-09-17 08:56:11 +020048 head=$(git rev-parse --verify HEAD 2>/dev/null); then
Nico Schottelius33252572009-05-16 14:00:56 +020049
Michal Marek09155122010-06-17 15:14:58 +020050 # 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.
Bhaskar Chowdhury3c96bdd2019-10-23 07:24:27 +053052 if [ -z "$(git describe --exact-match 2>/dev/null)" ]; then
Michal Marek09155122010-06-17 15:14:58 +020053
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.
Masahiro Yamada630ff0f2021-05-23 12:14:27 +090062 if atag="$(git describe 2>/dev/null)"; then
63 echo "$atag" | awk -F- '{printf("-%05d", $(NF-1))}'
Michal Marek09155122010-06-17 15:14:58 +020064 fi
Masahiro Yamada630ff0f2021-05-23 12:14:27 +090065
66 # Add -g and exactly 12 hex chars.
67 printf '%s%s' -g "$(echo $head | cut -c1-12)"
Nico Schottelius33252572009-05-16 14:00:56 +020068 fi
Michal Marek09155122010-06-17 15:14:58 +020069
Brian Norrisff64dd42018-11-14 18:11:18 -080070 # Check for uncommitted changes.
Masahiro Yamadaffaf62a2021-05-23 12:14:26 +090071 # This script must avoid any write attempt to the source tree,
72 # which might be read-only.
73 # You cannot use 'git describe --dirty' because it tries to
74 # create .git/index.lock .
Brian Norrisff64dd42018-11-14 18:11:18 -080075 # First, with git-status, but --no-optional-locks is only
76 # supported in git >= 2.14, so fall back to git-diff-index if
77 # it fails. Note that git-diff-index does not refresh the
78 # index, so it may give misleading results. See
79 # git-update-index(1), git-diff-index(1), and git-status(1).
80 if {
81 git --no-optional-locks status -uno --porcelain 2>/dev/null ||
82 git diff-index --name-only HEAD
Masahiro Yamadaa2be76a2021-05-23 12:14:25 +090083 } | read dummy; then
Michal Marek09155122010-06-17 15:14:58 +020084 printf '%s' -dirty
85 fi
Rene Scharfe117a93d2006-01-04 20:42:03 +010086 fi
Michal Marek09155122010-06-17 15:14:58 +020087}
Aron Griffis3dce1742007-11-28 16:55:44 -050088
Michal Marek09155122010-06-17 15:14:58 +020089collect_files()
90{
Masahiro Yamada7a82e3f2019-10-01 21:17:24 +090091 local file res=
Michal Marek09155122010-06-17 15:14:58 +020092
93 for file; do
94 case "$file" in
95 *\~*)
96 continue
97 ;;
98 esac
99 if test -e "$file"; then
100 res="$res$(cat "$file")"
101 fi
102 done
103 echo "$res"
104}
105
106if $scm_only; then
Michal Marekb003afe2010-07-15 10:36:37 +0200107 if test ! -e .scmversion; then
108 res=$(scm_version)
109 echo "$res" >.scmversion
110 fi
Aron Griffis3dce1742007-11-28 16:55:44 -0500111 exit
112fi
113
Masahiro Yamada7d153692021-12-14 11:53:52 +0900114if ! test -e include/config/auto.conf; then
Wolfram Sang78283edf2016-06-06 21:00:38 +0200115 echo "Error: kernelrelease not valid - run 'make prepare' to update it" >&2
Michal Marek09155122010-06-17 15:14:58 +0200116 exit 1
117fi
Aron Griffis3dce1742007-11-28 16:55:44 -0500118
Michal Marek09155122010-06-17 15:14:58 +0200119# localversion* files in the build and source directory
120res="$(collect_files localversion*)"
121if test ! "$srctree" -ef .; then
122 res="$res$(collect_files "$srctree"/localversion*)"
123fi
124
125# CONFIG_LOCALVERSION and LOCALVERSION (if set)
Masahiro Yamada129ab0d2021-12-14 11:53:53 +0900126config_localversion=$(sed -n 's/^CONFIG_LOCALVERSION=\(.*\)$/\1/p' include/config/auto.conf)
Masahiro Yamada7d153692021-12-14 11:53:52 +0900127res="${res}${config_localversion}${LOCALVERSION}"
Michal Marek09155122010-06-17 15:14:58 +0200128
129# scm version string if not at a tagged commit
Masahiro Yamada7d153692021-12-14 11:53:52 +0900130if grep -q "^CONFIG_LOCALVERSION_AUTO=y$" include/config/auto.conf; then
Michal Marek09155122010-06-17 15:14:58 +0200131 # full scm version string
132 res="$res$(scm_version)"
Mikulas Patocka5df99be2021-07-12 15:35:46 -0400133elif [ "${LOCALVERSION+set}" != "set" ]; then
134 # If the variable LOCALVERSION is not set, append a plus
135 # sign if the repository is not in a clean annotated or
136 # signed tagged state (as git describe only looks at signed
137 # or annotated tags - git tag -a/-s).
138 #
139 # If the variable LOCALVERSION is set (including being set
140 # to an empty string), we don't want to append a plus sign.
Masahiro Yamada042da422021-05-23 12:14:28 +0900141 scm=$(scm_version --short)
142 res="$res${scm:++}"
Rene Scharfe117a93d2006-01-04 20:42:03 +0100143fi
Bryan Wuba3d05f2008-02-03 14:13:26 +0800144
Michal Marek09155122010-06-17 15:14:58 +0200145echo "$res"