From af3407c277e0ee4a45a963e080daf0d513661009 Mon Sep 17 00:00:00 2001 From: Miquel Sabaté Solà Date: Wed, 1 Jul 2026 10:11:45 +0200 Subject: kbuild: update documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit A lot of stuff was outdated after the addition of options like '-l/--local'. Signed-off-by: Miquel Sabaté Solà --- bin/kbuild | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/bin/kbuild b/bin/kbuild index 481abad..0d61ece 100755 --- a/bin/kbuild +++ b/bin/kbuild @@ -15,8 +15,9 @@ # along with this program. If not, see . ##### -# Build the Linux Kernel and bundle it into a tarball that can then be used on -# another machine. After you call this script it will: +# Build the Linux Kernel with different install options. After you call this +# script it will: +# # 1. Call `defconfig`/`oldconfig` depending on whether the `.config` file # exists or not. # 2. Call `menuconfig` so the user can double check the configuration. @@ -27,13 +28,18 @@ # You can also pass some additional options, check the -h/--help message to read # more about them. # -# After that just send the resulting tarball to the machine where you want to -# install this kernel. In there you just need to untar the given bundle and then -# run the `install.sh` script from within the resulting directory. This will: +# By default kbuild will produce a tarball so you can install the kernel on a +# target machine. In there you just need to untar the given bundle and then run +# the 'install.sh' script from within the resulting directory. This will: +# # 1. Copy recursively all the files into their proper paths. # 2. Make an initramfs for the new image. # 3. Run your $EDITOR to update the boot loader configuration. # +# If you provide the '-l/--local' option then the tarball is not produced, and +# the 'install.sh' and 'uninstall.sh' scripts are left in the current +# directory so you can run them on your current machine. +# # *NOTE*: this script expects the `ARCH` environment variable to be set, and if # that doesn't match the current architecture, then it will expect to have # `CROSS_COMPILE` set as well. -- cgit v1.2.3