kbuild: do not put .scmversion into the source tarball
[linux-block.git] / scripts / setlocalversion
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
13 usage() {
14         echo "Usage: $0 [srctree]" >&2
15         exit 1
16 }
17
18 srctree=.
19 if test $# -gt 0; then
20         srctree=$1
21         shift
22 fi
23 if test $# -gt 0 -o ! -d "$srctree"; then
24         usage
25 fi
26
27 scm_version()
28 {
29         local short
30         short=false
31
32         cd "$srctree"
33         if test "$1" = "--short"; then
34                 short=true
35         fi
36
37         # Check for git and a git repo.
38         if test -z "$(git rev-parse --show-cdup 2>/dev/null)" &&
39            head=$(git rev-parse --verify HEAD 2>/dev/null); then
40
41                 # If we are at a tagged commit (like "v2.6.30-rc6"), we ignore
42                 # it, because this version is defined in the top level Makefile.
43                 if [ -z "$(git describe --exact-match 2>/dev/null)" ]; then
44
45                         # If only the short version is requested, don't bother
46                         # running further git commands
47                         if $short; then
48                                 echo "+"
49                                 return
50                         fi
51                         # If we are past a tagged commit (like
52                         # "v2.6.30-rc5-302-g72357d5"), we pretty print it.
53                         if atag="$(git describe 2>/dev/null)"; then
54                                 echo "$atag" | awk -F- '{printf("-%05d", $(NF-1))}'
55                         fi
56
57                         # Add -g and exactly 12 hex chars.
58                         printf '%s%s' -g "$(echo $head | cut -c1-12)"
59                 fi
60
61                 # Check for uncommitted changes.
62                 # This script must avoid any write attempt to the source tree,
63                 # which might be read-only.
64                 # You cannot use 'git describe --dirty' because it tries to
65                 # create .git/index.lock .
66                 # First, with git-status, but --no-optional-locks is only
67                 # supported in git >= 2.14, so fall back to git-diff-index if
68                 # it fails. Note that git-diff-index does not refresh the
69                 # index, so it may give misleading results. See
70                 # git-update-index(1), git-diff-index(1), and git-status(1).
71                 if {
72                         git --no-optional-locks status -uno --porcelain 2>/dev/null ||
73                         git diff-index --name-only HEAD
74                 } | read dummy; then
75                         printf '%s' -dirty
76                 fi
77         fi
78 }
79
80 collect_files()
81 {
82         local file res=
83
84         for file; do
85                 case "$file" in
86                 *\~*)
87                         continue
88                         ;;
89                 esac
90                 if test -e "$file"; then
91                         res="$res$(cat "$file")"
92                 fi
93         done
94         echo "$res"
95 }
96
97 if ! test -e include/config/auto.conf; then
98         echo "Error: kernelrelease not valid - run 'make prepare' to update it" >&2
99         exit 1
100 fi
101
102 # localversion* files in the build and source directory
103 res="$(collect_files localversion*)"
104 if test ! "$srctree" -ef .; then
105         res="$res$(collect_files "$srctree"/localversion*)"
106 fi
107
108 # CONFIG_LOCALVERSION and LOCALVERSION (if set)
109 config_localversion=$(sed -n 's/^CONFIG_LOCALVERSION=\(.*\)$/\1/p' include/config/auto.conf)
110 res="${res}${config_localversion}${LOCALVERSION}"
111
112 # scm version string if not at a tagged commit
113 if grep -q "^CONFIG_LOCALVERSION_AUTO=y$" include/config/auto.conf; then
114         # full scm version string
115         res="$res$(scm_version)"
116 elif [ "${LOCALVERSION+set}" != "set" ]; then
117         # If the variable LOCALVERSION is not set, append a plus
118         # sign if the repository is not in a clean annotated or
119         # signed tagged state (as git describe only looks at signed
120         # or annotated tags - git tag -a/-s).
121         #
122         # If the variable LOCALVERSION is set (including being set
123         # to an empty string), we don't want to append a plus sign.
124         scm=$(scm_version --short)
125         res="$res${scm:++}"
126 fi
127
128 echo "$res"