Skip to content

README: describe ukify support #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
xypron wants to merge 1 commit into
base: ukify
Choose a base branch
from
Open

README: describe ukify support #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,35 @@ config = "./my_intel_defconfig"
config = "defconfig" # just use defconfig on riscv64
```

### Build a Unified Kernel Image (UKI) with ukify

ukpack can bundle the kernel image and its device-trees into a [Unified Kernel
Image (UKI)][uki] using [`ukify`][ukify-man], a tool shipped with [systemd].
An EFI stub will be prepended that contains the logic to select the right
device-tree either based on hardware IDs or on the compatible string of a
firmware installed device-tree.

[uki]: https://uapi-group.org/specifications/specs/unified_kernel_image/
[ukify-man]: https://www.freedesktop.org/software/systemd/man/latest/ukify.html
[systemd]: https://systemd.io/

To enable this, set the `ukify` key to `true` in the TOML footer:
```toml
ukify = true
```

If you want to use your own build of the stub instead set `ukify` to the path to that
stub file instead of `true.

As with `config`, `ukify` can be set per architecture:
```toml
arch = "amd64 arm64"
[amd64]
ukify = true
[arm64]
ukify = "./arm64-stub.efi"
```

### Update your kernel

To create a new version of your kernel,
Expand Down