[PATCH] docs: add example of building the Linux kernel

[Anup Patel]

On Tue, Oct 8, 2024 at 3:20 PM Tim Hutt <tdhutt at gmail.com> wrote:
>
> Slightly expand the QEMU docs to explain how to build the flat Linux kernel image.
>
> Signed-off-by: Tim Hutt <tdhutt at gmail.com>
> Reviewed-by: Samuel Holland <samuel.holland at sifive.com>

LGTM.

Reviewed-by: Anup Patel <anup at brainfault.org>

Applied this patch to the riscv/opensbi repo.

Thanks,
Anup

> ---
>  docs/platform/qemu_virt.md | 9 ++++++++-
>  1 file changed, 8 insertions(+), 1 deletion(-)
>
> diff --git a/docs/platform/qemu_virt.md b/docs/platform/qemu_virt.md
> index 0783be4..fd87ee5 100644
> --- a/docs/platform/qemu_virt.md
> +++ b/docs/platform/qemu_virt.md
> @@ -56,7 +56,14 @@ 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:
>  ```
> --
> 2.39.2
>
>
> --
> opensbi mailing list
> opensbi at lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/opensbi