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