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