Message ID | 20241004131410.772651-1-tdhutt@gmail.com |
---|---|
State | New |
Headers | show |
Series | docs: add example of building the Linux kernel | expand |
On 2024-10-04 8:14 AM, Tim Hutt wrote: > Slightly expand the QEMU docs to explain how to build the flat Linux kernel image. This patch also needs your signoff (Signed-off-by:). > --- > docs/platform/qemu_virt.md | 8 +++++++- > 1 file changed, 7 insertions(+), 1 deletion(-) > > diff --git a/docs/platform/qemu_virt.md b/docs/platform/qemu_virt.md > index 0783be4..71faf42 100644 > --- a/docs/platform/qemu_virt.md > +++ b/docs/platform/qemu_virt.md > @@ -56,7 +56,13 @@ qemu-system-riscv64 -M virt -m 256M -nographic \ > **Linux Kernel Payload** > > Note: We assume that the Linux kernel is compiled using > -*arch/riscv/configs/defconfig*. > +*arch/riscv/configs/defconfig*. The kernel must be a flattened image (a file called `Image`) rather than an ELF (`vmlinux`). Please wrap to 80 columns to match the rest of the file. > + > +Example of building a Linux kernel: > +``` > +make ARCH=riscv CROSS_COMPILE=riscv64-linux- defconfig > +make ARCH=riscv CROSS_COMPILE=riscv64-linux- Image > +``` > > Build: > ``` With these fixed, you can add: Reviewed-by: Samuel Holland <samuel.holland@sifive.com>
diff --git a/docs/platform/qemu_virt.md b/docs/platform/qemu_virt.md index 0783be4..71faf42 100644 --- a/docs/platform/qemu_virt.md +++ b/docs/platform/qemu_virt.md @@ -56,7 +56,13 @@ qemu-system-riscv64 -M virt -m 256M -nographic \ **Linux Kernel Payload** Note: We assume that the Linux kernel is compiled using -*arch/riscv/configs/defconfig*. +*arch/riscv/configs/defconfig*. The kernel must be a flattened image (a file called `Image`) rather than an ELF (`vmlinux`). + +Example of building a Linux kernel: +``` +make ARCH=riscv CROSS_COMPILE=riscv64-linux- defconfig +make ARCH=riscv CROSS_COMPILE=riscv64-linux- Image +``` Build: ```