[PATCH v3 3/3] doc: board: Add minimal documentation for Sielaff i.MX6 Solo board

[Heinrich Schuchardt]

On 15.02.24 2:35 PM, Frieder Schrempf wrote:
> From: Frieder Schrempf <frieder.schrempf at kontron.de>
>
> Describe how to build and boot for the Sielaff i.MX6 Solo board.
>
> Signed-off-by: Frieder Schrempf <frieder.schrempf at kontron.de>
> ---
> Changes in v3:
> * include docs in upper-level index
>
> Changes in v2:
> * none
> ---
>   doc/board/index.rst                  |  1 +
>   doc/board/sielaff/imx6dl-sielaff.rst | 32 ++++++++++++++++++++++++++++
>   doc/board/sielaff/index.rst          |  9 ++++++++
>   3 files changed, 42 insertions(+)
>   create mode 100644 doc/board/sielaff/imx6dl-sielaff.rst
>   create mode 100644 doc/board/sielaff/index.rst
>
> diff --git a/doc/board/index.rst b/doc/board/index.rst
> index d0f9f355d2e..62357c99388 100644
> --- a/doc/board/index.rst
> +++ b/doc/board/index.rst
> @@ -42,6 +42,7 @@ Board-specific doc
>      renesas/index
>      rockchip/index
>      samsung/index
> +   sielaff/index
>      siemens/index
>      sifive/index
>      sipeed/index
> diff --git a/doc/board/sielaff/imx6dl-sielaff.rst b/doc/board/sielaff/imx6dl-sielaff.rst
> new file mode 100644
> index 00000000000..24dd67ccaef
> --- /dev/null
> +++ b/doc/board/sielaff/imx6dl-sielaff.rst
> @@ -0,0 +1,32 @@
> +.. SPDX-License-Identifier: GPL-2.0+
> +
> +Sielaff i.MX6 Solo Board
> +========================
> +
> +The Sielaff i.MX6 Solo board is a control and HMI board for vending
> +machines.

Thank you for providing the build instruction.

I had to look up the abbreviation:

%s/HMI/Human Machine Interface (HMI)/

> +
> +Quick Start
> +-----------
> +
> +- Build U-Boot
> +- Boot

These lines are not needed. We have a navigation tree on the left side
of the generated HTML page.

> +
> +Build U-Boot
> +^^^^^^^^^^^^
> +
> +.. code-block:: bash
> +
> +   $ make imx6dl_sielaff_defconfig
> +   $ make CROSS_COMPILE=arm-none-linux-gnueabihf-

U-Boot does not use floats.

make CROSS_COMPILE=arm-linux-gnueabi-

> +
> +Burn the flash.bin to SD card at an offset of 1 KiB:

Copy the flash.bin file to an SD card at an offset of 1 KiB:

> +
> +.. code-block:: bash
> +
> +   $ dd if=flash.bin of=/dev/sd[x] bs=1K seek=1 conv=notrunc

Please, remove '$ '. It makes copy and paste more difficult.
Anyway $ is the wrong prompt. Only root can use dd.
If you really want a prompt, use:

.. prompt:: bash #

conv=notrunc has no effect on SD-cards but is needed when copying to an
image file.

Best regards

Heinrich

> +
> +Boot
> +^^^^
> +
> +Put the SD card in the slot on the board and apply power.
> diff --git a/doc/board/sielaff/index.rst b/doc/board/sielaff/index.rst
> new file mode 100644
> index 00000000000..a8376484d88
> --- /dev/null
> +++ b/doc/board/sielaff/index.rst
> @@ -0,0 +1,9 @@
> +.. SPDX-License-Identifier: GPL-2.0+
> +
> +Sielaff
> +=======
> +
> +.. toctree::
> +   :maxdepth: 2
> +
> +   imx6dl-sielaff