[PATCH] doc: add bootelf command documentation

[Heinrich Schuchardt]

On 6/30/24 12:37, Maxim Moskalets wrote:
> Signed-off-by: Maxim Moskalets <maximmosk4 at gmail.com>
> ---
>   doc/usage/cmd/bootelf.rst | 52 +++++++++++++++++++++++++++++++++++++++
>   1 file changed, 52 insertions(+)
>   create mode 100644 doc/usage/cmd/bootelf.rst
>
> diff --git a/doc/usage/cmd/bootelf.rst b/doc/usage/cmd/bootelf.rst
> new file mode 100644
> index 0000000000..5472a90fe2
> --- /dev/null
> +++ b/doc/usage/cmd/bootelf.rst
> @@ -0,0 +1,52 @@
> +.. SPDX-License-Identifier: GPL-2.0+
> +.. Copyright 2024, Maxim Moskalets <maximmosk4 at gmail.com>
> +
> +.. index::
> +   single: bootelf (command)
> +
> +bootelf command
> +===============
> +
> +Synopsis
> +--------
> +
> +::
> +
> +    bootelf [-p|-s] [-d <fdt_addr>] [<image_addr> [<arg>]...]
> +
> +Description
> +-----------
> +
> +The *bootelf* command is used to launch a ELF binary at *image_addr*. If
> +*image_addr* is not specified, the bootelf command will try to find image in
> +*image_load_addr* variable (*CONFIG\_SYS\_LOAD\_ADDR* by default).
> +
> +Args after *image_addr* will be passed to application in common *argc*, *argv*
> +format.
> +
> +A command sequence to run a ELF image using FDT might look like
> +
> +::
> +
> +    load mmc 0:1 ${loadaddr} /kernel.elf
> +    load mmc 0:1 ${fdt_addr_r} /soc-board.dtb
> +    bootelf -d ${fdt_addr_r} ${loadaddr} ${loadaddr}

Thank you for providing this man-page.

Please, move the example to an Examples section. See other man-pages.

> +
> +image_addr
> +    Address of the ELF binary.
> +
> +fdt_addr
> +    Address of the device-tree. This argument in only needed if bootable
> +    application uses FDT that requires additional setup (like /memory node).
> +
> +arg
> +    Any text arguments for bootable application. This is usually the address
> +    of the device-tree.
> +
> +Flags:
> +
> +-p|-s
> +    Load ELF image via program headers (-p) or via section headers (-s).

Please, separate -p -s into different lines.

> +
> +-d
> +    Setup FDT by address. Available only if CONFIG_CMD_ELF_FDT_SETUP is enabled.

Please, add a Configuration section like in the other man-pages
describing which configuration setting enables the command.

Best regards

Heinrich