Changes in setlocalversion

e2ff1219 - setlocalversion: add -e option

Mon, 18 Nov 2024 23:09:06 +0000

setlocalversion: add -e optionSet the -e option to ensure this script fails on any unexpected errors.Without this change, the kernel build may continue running with anincorrect string in include/config/kernel.release.Currently, try_tag() returns 1 when the expected tag is not found as anancestor, but this is a case where the script should continue.Signed-off-by: Masahiro Yamada List of files: /linux-6.15/scripts/setlocalversion

523f3dbc - setlocalversion: work around "git describe" performance

Mon, 18 Nov 2024 11:01:54 +0000

setlocalversion: work around "git describe" performanceContrary to expectations, passing a single candidate tag to "gitdescribe" is slower than not passing any --match options. $ time git describe --debug ... traversed 10619 commits ... v6.12-rc5-63-g0fc810ae3ae1 real 0m0.169s $ time git describe --match=v6.12-rc5 --debug ... traversed 1310024 commits v6.12-rc5-63-g0fc810ae3ae1 real 0m1.281sIn fact, the --debug output shows that git traverses all or most ofhistory. For some repositories and/or git versions, those 1.3s areactually 10-15 seconds.This has been acknowledged as a performance bug in git [1], and a fixis on its way [2]. However, no solution is yet in git.git, and evenwhen one lands, it will take quite a while before it finds its way toa release and for $random_kernel_developer to pick that up.So rewrite the logic to use plumbing commands. For each of thecandidate values of $tag, we ask: (1) is $tag even an annotatedtag? (2) Is it eligible to describe HEAD, i.e. an ancestor ofHEAD? (3) If so, how many commits are in $tag..HEAD?I have tested that this produces the same output as the current scriptfor ~700 random commits between v6.9..v6.10. For those 700 commits,and in my git repo, the 'make -s kernelrelease' command is on average~4 times faster with this patch applied (geometric mean of ratios).For the commit mentioned in Josh's original report [3], thetime-consuming part of setlocalversion goes from$ time git describe --match=v6.12-rc5 c1e939a21eb1v6.12-rc5-44-gc1e939a21eb1real 0m1.210sto$ time git rev-list --count --left-right v6.12-rc5..c1e939a21eb10 44real 0m0.037s[1] https://lore.kernel.org/git/20241101113910.GA2301440@coredump.intra.peff.net/[2] https://lore.kernel.org/git/20241106192236.GC880133@coredump.intra.peff.net/[3] https://lore.kernel.org/lkml/309549cafdcfe50c4fceac3263220cc3d8b109b2.1730337435.git.jpoimboe@kernel.org/Reported-by: Sean Christopherson Closes: https://lore.kernel.org/lkml/ZPtlxmdIJXOe0sEy@google.com/Reported-by: Josh Poimboeuf Closes: https://lore.kernel.org/lkml/309549cafdcfe50c4fceac3263220cc3d8b109b2.1730337435.git.jpoimboe@kernel.org/Tested-by: Josh Poimboeuf Signed-off-by: Rasmus Villemoes Signed-off-by: Masahiro Yamada List of files: /linux-6.15/scripts/setlocalversion

01e89a4a - scripts/setlocalversion: also consider annotated tags of the form vx.y.z-${file_localversion}

Fri, 04 Aug 2023 12:05:36 +0000

scripts/setlocalversion: also consider annotated tags of the form vx.y.z-${file_localversion}Commit 6ab7e1f95e96 ("setlocalversion: use only the correct releasetag for git-describe") was absolutely correct to limit which annotatedtags would be used to compute the -01234-gabcdef suffix. Otherwise, ifsome random annotated tag exists closer to HEAD than the vX.Y.Z one,the commit count would be too low.However, since the version string always includes the${file_localversion} part, now the problem is that the count can betoo high. For example, building an 6.4.6-rt8 kernel with a few patcheson top, I currently get$ make -s kernelrelease6.4.6-rt8-00128-gd78b7f406397But those 128 commits include the 100 commits that are inv6.4.6..v6.4.6-rt8, so this is somewhat misleading.Amend the logic so that, in addition to the linux-next consideration,the script also looks for a tag corresponding to the 6.4.6-rt8 part ofwhat will become the `uname -r` string. With this patch (so 29 patcheson top of v6.4.6-rt8), one instead gets$ make -s kernelrelease6.4.6-rt8-00029-gd533209291a2While there, note that the line git describe --exact-match --match=$tag $tag 2>/dev/nullobviously asks if $tag is an annotated tag, but it does not actuallytell if the commit pointed to has any relation to HEAD. So remove bothuses of --exact-match, and instead just ask if the descriptiongenerated is identical to the tag we provided. Since we then alreadyhave the result of git describe --match=$tagwe also end up reducing the number of times we invoke "git describe".Signed-off-by: Rasmus Villemoes Signed-off-by: Masahiro Yamada List of files: /linux-6.15/scripts/setlocalversion

3354c64d - scripts/setlocalversion: clean up stale comment

Thu, 03 Aug 2023 11:50:20 +0000

scripts/setlocalversion: clean up stale commentNobody has complained since 2a73cce2dad3 ("scripts/setlocalversion:remove mercurial, svn and git-svn supports"), so let's also clean upthe header comment accordingly.Signed-off-by: Rasmus Villemoes Signed-off-by: Masahiro Yamada List of files: /linux-6.15/scripts/setlocalversion

05e96e96 - kbuild: use git-archive for source package creation

Wed, 15 Mar 2023 15:50:18 +0000

kbuild: use git-archive for source package creationCommit 5c3d1d0abb12 ("kbuild: add a tool to list files ignored by git")added a new tool, scripts/list-gitignored. My intention was to createsource packages without cleaning the source tree, without relying on git.Linus strongly objected to it, and suggested using 'git archive' instead.[1] [2] [3]This commit goes in that direction - Remove scripts/list-gitignored.cand rewrites Makefiles and scripts to use 'git archive' for buildingDebian and RPM source packages. It also makes 'make perf-tar*-src-pkg'use 'git archive' again.Going forward, building source packages is only possible in a git-managedtree. Building binary packages does not require git.[1]: https://lore.kernel.org/lkml/CAHk-=wi49sMaC7vY1yMagk7eqLK=1jHeHQ=yZ_k45P=xBccnmA@mail.gmail.com/[2]: https://lore.kernel.org/lkml/CAHk-=wh5AixGsLeT0qH2oZHKq0FLUTbyTw4qY921L=PwYgoGVw@mail.gmail.com/[3]: https://lore.kernel.org/lkml/CAHk-=wgM-W6Fu==EoAVCabxyX8eYBz9kNC88-tm9ExRQwA79UQ@mail.gmail.com/Fixes: 5c3d1d0abb12 ("kbuild: add a tool to list files ignored by git")Fixes: e0ca16749ac3 ("kbuild: make perf-tar*-src-pkg work without relying on git")Suggested-by: Linus Torvalds Signed-off-by: Masahiro Yamada List of files: /linux-6.15/scripts/setlocalversion

6ab7e1f9 - setlocalversion: use only the correct release tag for git-describe

Sun, 05 Feb 2023 12:09:57 +0000

setlocalversion: use only the correct release tag for git-describeCurrently, setlocalversion uses any annotated tag for git-describe.If we are at a tagged commit, it will not append the commit hash. $ git checkout v6.2-rc1^ $ make -s defconfig kernelrelease 6.1.0-14595-g292a089d78d3 $ git tag -a foo -m foo $ make -s kernelrelease 6.1.0If a local tag 'foo' exists, it pretends to be a released version'6.1.0', while there are many commits on top of it.The output should be consistent irrespective of such a local tag.Pass the correct release tag to --match option of git-describe.In the mainline kernel, the SUBLEVEL is always '0', which is omittedfrom the tag. KERNELVERSION annotated tag 6.1.0 -> v6.1 (mainline) 6.2.0-rc5 -> v6.2-rc5 (mainline, release candidate) 6.1.7 -> v6.1.7 (stable)To preserve the behavior in linux-next, use the tag derived fromlocalversion* files if exists. In linux-next, the local version isspecified by the localversion-next file.Signed-off-by: Masahiro Yamada List of files: /linux-6.15/scripts/setlocalversion

eed36d77 - setlocalversion: clean up the construction of version output

Sun, 05 Feb 2023 12:09:56 +0000

setlocalversion: clean up the construction of version outputConcatenate all components in the last line instead of accumulatingthem into the 'res' variable.No functional change is intended. A preparation for the next change.Signed-off-by: Masahiro Yamada List of files: /linux-6.15/scripts/setlocalversion

ec31f868 - setlocalversion: absorb $(KERNELVERSION)

Sun, 22 Jan 2023 14:14:25 +0000

setlocalversion: absorb $(KERNELVERSION)Print $(KERNELVERSION) in setlocalversion so that the callers getsimpler.Signed-off-by: Masahiro Yamada List of files: /linux-6.15/scripts/setlocalversion

75280bdf - setlocalversion: make indentation shallower

Sun, 22 Jan 2023 14:14:23 +0000

setlocalversion: make indentation shallowerReturn earlier if we are not in the correct git repository. This makesthe code more readable.Signed-off-by: Masahiro Yamada Reviewed-by: Nicolas Schier List of files: /linux-6.15/scripts/setlocalversion

992ebfab - setlocalversion: simplify the construction of the short version

Sun, 22 Jan 2023 14:14:22 +0000

setlocalversion: simplify the construction of the short versionWith the --short option given, scm_version() prints "+".Just append it.Signed-off-by: Masahiro Yamada Reviewed-by: Nicolas Schier List of files: /linux-6.15/scripts/setlocalversion

f6e09b07 - kbuild: do not put .scmversion into the source tarball

Sun, 22 Jan 2023 14:14:21 +0000

kbuild: do not put .scmversion into the source tarball.scmversion is used by (src)rpm-pkg and deb-pkg to carry KERNELRELEASE.In fact, deb-pkg does not rely on it any more because the generateddebian/rules specifies KERNELRELEASE from the command line.Do likwise for (src)rpm-pkg, and remove this feature.For the same reason, you do not need to save LOCALVERSION in thespec file.Signed-off-by: Masahiro Yamada Reviewed-by: Nicolas Schier List of files: /linux-6.15/scripts/setlocalversion

129ab0d2 - kbuild: do not quote string values in include/config/auto.conf

Tue, 14 Dec 2021 02:53:53 +0000

kbuild: do not quote string values in include/config/auto.confThe previous commit fixed up all shell scripts to not includeinclude/config/auto.conf.Now that include/config/auto.conf is only included by Makefiles,we can change it into a more Make-friendly form.Previously, Kconfig output string values enclosed with double-quotes(both in the .config and include/config/auto.conf): CONFIG_X="foo bar"Unlike shell, Make handles double-quotes (and single-quotes as well)verbatim. We must rip them off when used.There are some patterns: [1] $(patsubst "%",%,$(CONFIG_X)) [2] $(CONFIG_X:"%"=%) [3] $(subst ",,$(CONFIG_X)) [4] $(shell echo $(CONFIG_X))These are not only ugly, but also fragile.[1] and [2] do not work if the value contains spaces, like CONFIG_X=" foo bar "[3] does not work correctly if the value contains double-quotes like CONFIG_X="foo\"bar"[4] seems to work better, but has a cost of forking a process.Anyway, quoted strings were always PITA for our Makefiles.This commit changes Kconfig to stop quoting in include/config/auto.conf.These are the string type symbols referenced in Makefiles or scripts: ACPI_CUSTOM_DSDT_FILE ARC_BUILTIN_DTB_NAME ARC_TUNE_MCPU BUILTIN_DTB_SOURCE CC_IMPLICIT_FALLTHROUGH CC_VERSION_TEXT CFG80211_EXTRA_REGDB_KEYDIR EXTRA_FIRMWARE EXTRA_FIRMWARE_DIR EXTRA_TARGETS H8300_BUILTIN_DTB INITRAMFS_SOURCE LOCALVERSION MODULE_SIG_HASH MODULE_SIG_KEY NDS32_BUILTIN_DTB NIOS2_DTB_SOURCE OPENRISC_BUILTIN_DTB SOC_CANAAN_K210_DTB_SOURCE SYSTEM_BLACKLIST_HASH_LIST SYSTEM_REVOCATION_KEYS SYSTEM_TRUSTED_KEYS TARGET_CPU UNUSED_KSYMS_WHITELIST XILINX_MICROBLAZE0_FAMILY XILINX_MICROBLAZE0_HW_VER XTENSA_VARIANT_NAMEI checked them one by one, and fixed up the code where necessary.Signed-off-by: Masahiro Yamada List of files: /linux-6.15/scripts/setlocalversion

7d153696 - kbuild: do not include include/config/auto.conf from shell scripts

Tue, 14 Dec 2021 02:53:52 +0000

kbuild: do not include include/config/auto.conf from shell scriptsRichard Weinberger pointed out the risk of sourcing the kernel configfrom shell scripts [1], and proposed some patches [2], [3]. It is a goodpoint, but it took a long time because I was wondering how to fix this.This commit goes with simple grep approach because there are only a fewscripts including the kernel configuration.scripts/link_vmlinux.sh has references to a bunch of CONFIG options,all of which are boolean. I added is_enabled() helper asscripts/package/{mkdebian,builddeb} do.scripts/gen_autoksyms.sh uses 'eval', stating "to expand the whitelistpath". I removed it since it is the issue we are trying to fix.I was a bit worried about the cost of invoking the grep command overagain. I extracted the grep parts from it, and measured the cost. Itwas approximately 0.03 sec, which I hope is acceptable.[test code] $ cat test-grep.sh #!/bin/sh is_enabled() { grep -q "^$1=y" include/config/auto.conf } is_enabled CONFIG_LTO_CLANG is_enabled CONFIG_LTO_CLANG is_enabled CONFIG_STACK_VALIDATION is_enabled CONFIG_UNWINDER_ORC is_enabled CONFIG_FTRACE_MCOUNT_USE_OBJTOOL is_enabled CONFIG_VMLINUX_VALIDATION is_enabled CONFIG_FRAME_POINTER is_enabled CONFIG_GCOV_KERNEL is_enabled CONFIG_LTO_CLANG is_enabled CONFIG_RETPOLINE is_enabled CONFIG_X86_SMAP is_enabled CONFIG_LTO_CLANG is_enabled CONFIG_VMLINUX_MAP is_enabled CONFIG_KALLSYMS_ALL is_enabled CONFIG_KALLSYMS_ABSOLUTE_PERCPU is_enabled CONFIG_KALLSYMS_BASE_RELATIVE is_enabled CONFIG_DEBUG_INFO_BTF is_enabled CONFIG_KALLSYMS is_enabled CONFIG_DEBUG_INFO_BTF is_enabled CONFIG_BPF is_enabled CONFIG_BUILDTIME_TABLE_SORT is_enabled CONFIG_KALLSYMS $ time ./test-grep.sh real 0m0.036s user 0m0.027s sys m0.009s[1]: https://lore.kernel.org/all/1919455.eZKeABUfgV@blindfold/[2]: https://lore.kernel.org/all/20180219092245.26404-1-richard@nod.at/[3]: https://lore.kernel.org/all/20210920213957.1064-2-richard@nod.at/Signed-off-by: Masahiro Yamada Reviewed-by: Nicolas Schier List of files: /linux-6.15/scripts/setlocalversion

5df99bec - scripts/setlocalversion: fix a bug when LOCALVERSION is empty

Mon, 12 Jul 2021 19:35:46 +0000

scripts/setlocalversion: fix a bug when LOCALVERSION is emptyThe commit 042da426f8eb ("scripts/setlocalversion: simplify the shortversion part") reduces indentation. Unfortunately, it also changes behaviorin a subtle way - if the user has empty "LOCALVERSION" variable, the plussign is appended to the kernel version. It wasn't appended before.This patch reverts to the old behavior - we append the plus sign only ifthe LOCALVERSION variable is not set.Fixes: 042da426f8eb ("scripts/setlocalversion: simplify the short version part")Signed-off-by: Mikulas Patocka Signed-off-by: Masahiro Yamada List of files: /linux-6.15/scripts/setlocalversion

042da426 - scripts/setlocalversion: simplify the short version part

Sun, 23 May 2021 03:14:28 +0000

scripts/setlocalversion: simplify the short version partReduce the indentation.Signed-off-by: Masahiro Yamada Reviewed-by: Greg Kroah-Hartman Reviewed-by: Nico Schottelius List of files: /linux-6.15/scripts/setlocalversion

630ff0fa - scripts/setlocalversion: factor out 12-chars hash construction

Sun, 23 May 2021 03:14:27 +0000

scripts/setlocalversion: factor out 12-chars hash constructionBoth of if and else parts append exactly 12 hex chars, but indifferent ways.Factor out the else part because we need to support it without relyingon git-describe. Remove the --abbrev=12 option since we do not use thehash from git-describe anyway.Signed-off-by: Masahiro Yamada Reviewed-by: Greg Kroah-Hartman Reviewed-by: Nico Schottelius List of files: /linux-6.15/scripts/setlocalversion

ffaf62a8 - scripts/setlocalversion: add more comments to -dirty flag detection

Sun, 23 May 2021 03:14:26 +0000

scripts/setlocalversion: add more comments to -dirty flag detectionThis script stumbled on the read-only source tree over again: - a2bb90a08cb3 ("kbuild: fix delay in setlocalversion on readonly source") - cdf2bc632ebc ("scripts/setlocalversion on write-protected source tree") - 8ef14c2c41d9 ("Revert "scripts/setlocalversion: git: Make -dirty check more robust"") - ff64dd485730 ("scripts/setlocalversion: Improve -dirty check with git-status --no-optional-locks")Add comments to clarify that this script should never ever try to writeto the source tree.'git describe --dirty' might look as a simple solution for appendingthe -dirty string, but we cannot use it because it creates the.git/index.lock file.Signed-off-by: Masahiro Yamada Reviewed-by: Greg Kroah-Hartman Reviewed-by: Nico Schottelius List of files: /linux-6.15/scripts/setlocalversion

a2be76a3 - scripts/setlocalversion: remove workaround for old make-kpkg

Sun, 23 May 2021 03:14:25 +0000

scripts/setlocalversion: remove workaround for old make-kpkgThis reverts commit b052ce4c840e ("kbuild: fix false positive -dirtytag caused by make-kpkg").If I understand correctly, this problem occurred in very old versionsof make-kpkg. When I tried a newer version, make-kpkg did not touchscripts/package/Makefile.Anyway, Debian uses 'make deb-pkg' instead of make-kpkg these days.Debian handbook [1] mentions it as "the good old days": "CULTURE The good old days of kernel-package Before the Linux build system gained the ability to build proper Debian packages, the recommended way to build such packages was to use make-kpkg from the kernel-package package."[1]: https://debian-handbook.info/browse/stable/sect.kernel-compilation.htmlSigned-off-by: Masahiro Yamada Reviewed-by: Greg Kroah-Hartman Reviewed-by: Nico Schottelius List of files: /linux-6.15/scripts/setlocalversion

2a73cce2 - scripts/setlocalversion: remove mercurial, svn and git-svn supports

Sun, 23 May 2021 03:14:24 +0000

scripts/setlocalversion: remove mercurial, svn and git-svn supportsThe mercurial, svn, git-svn supports were added by the following commits: - 3dce174cfcba ("kbuild: support mercurial in setlocalversion") - ba3d05fb6369 ("kbuild: add svn revision information to setlocalversion") - ff80aa97c9b4 ("setlocalversion: add git-svn support")They did not explain why they are useful for the kernel source tree.Let's revert all of them, and see if somebody will complain about it.Signed-off-by: Masahiro Yamada Reviewed-by: Greg Kroah-Hartman Reviewed-by: Nico Schottelius List of files: /linux-6.15/scripts/setlocalversion

77a88274 - kbuild: replace LANG=C with LC_ALL=C

Fri, 30 Apr 2021 01:56:27 +0000

kbuild: replace LANG=C with LC_ALL=CLANG gives a weak default to each LC_* in case it is not explicitlydefined. LC_ALL, if set, overrides all other LC_* variables. LANG < LC_CTYPE, LC_COLLATE, LC_MONETARY, LC_NUMERIC, ... < LC_ALLThis is why documentation such as [1] suggests to set LC_ALL in buildscripts to get the deterministic result.LANG=C is not strong enough to override LC_* that may be set by endusers.[1]: https://reproducible-builds.org/docs/locales/Signed-off-by: Masahiro Yamada Acked-by: Michael Ellerman (powerpc)Reviewed-by: Matthias Maennich Acked-by: Matthieu Baerts (mptcp)Reviewed-by: Greg Kroah-Hartman List of files: /linux-6.15/scripts/setlocalversion