github/kata-containers
1
0
Fork 1
mirror of https://github.com/kata-containers/kata-containers.git synced 2025-04-27 19:35:32 +00:00
Code Issues Projects Releases Wiki Activity

kernel: Update the outdated usage in the readme

Browse Source 
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 <pbrehpuum@gmail.com>
This commit is contained in:
Shunsuke Kimura 2025-03-21 22:40:36 +09:00
parent d81a1747bd
commit c0af0b43e0
1 changed files with 5 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
tools/packaging/kernel/README.md
View File

@ -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] <command> <argument>
Commands:
- setup
- build
- install
Options:
-a <arch> : Arch target to build the kernel, such as aarch64/ppc64le/s390x/x86_64.
-c <path> : Path to config file to build the kernel.
-d : Enable bash debug.
-e : Enable experimental kernel.
-f : Enable force generate config when setup.
-g <vendor> : GPU vendor, intel or nvidia.
-h : Display this help.
-H <deb|rpm> : Linux headers for guest fs module building.
-k <path> : Path to kernel to build.
-p <path> : Path to a directory with patches to apply to kernel, only patches in top-level directory are applied.
-t <hypervisor> : Hypervisor_target.
-v <version> : 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.