From c0af0b43e035a34a61cbd0801674a7278729573c Mon Sep 17 00:00:00 2001 From: Shunsuke Kimura Date: Fri, 21 Mar 2025 22:40:36 +0900 Subject: [PATCH] kernel: Update the outdated usage in the readme Since it is difficult to update the README when modifying the options of ./build-kernel.sh, instead of update the README, we encourage users to run the -h command. Fixes: #11065 Signed-off-by: Shunsuke Kimura --- tools/packaging/kernel/README.md | 36 +++++--------------------------- 1 file changed, 5 insertions(+), 31 deletions(-) diff --git a/tools/packaging/kernel/README.md b/tools/packaging/kernel/README.md index 0f1fc0c9d..a0709f8c0 100644 --- a/tools/packaging/kernel/README.md +++ b/tools/packaging/kernel/README.md @@ -17,44 +17,18 @@ The Linux kernel scripts further require a few packages (flex, bison, and libelf ## Usage -``` +Check the available options by running the help flag with: + +```bash $ ./build-kernel.sh -h -Overview: - - Build a kernel for Kata Containers - -Usage: - - build-kernel.sh [options] - -Commands: - -- setup - -- build - -- install - -Options: - - -a : Arch target to build the kernel, such as aarch64/ppc64le/s390x/x86_64. - -c : Path to config file to build the kernel. - -d : Enable bash debug. - -e : Enable experimental kernel. - -f : Enable force generate config when setup. - -g : GPU vendor, intel or nvidia. - -h : Display this help. - -H : Linux headers for guest fs module building. - -k : Path to kernel to build. - -p : Path to a directory with patches to apply to kernel, only patches in top-level directory are applied. - -t : Hypervisor_target. - -v : Kernel version to use if kernel path not provided. ``` Example: + ```bash $ ./build-kernel.sh -v 5.10.25 -g nvidia -f -d setup ``` + > **Note** > - `-v 5.10.25`: Specify the guest kernel version. > - `-g nvidia`: To build a guest kernel supporting Nvidia GPU.