diff mbox series

[v1,2/2] doc: board: toradex: verdin-am62: document update u-boot wrapper

Message ID 20230828220154.483362-3-marcel@ziswiler.com
State Accepted, archived
Commit b4b7eed4994413f1d02596593b8c4c1143bee142
Delegated to: Heinrich Schuchardt
Headers show
Series doc: board: toradex: documentation update | expand

Commit Message

Marcel Ziswiler Aug. 28, 2023, 10:01 p.m. UTC
From: Marcel Ziswiler <marcel.ziswiler@toradex.com>

Now with the update U-Boot wrappers having been sorted out, document
their usage.

Signed-off-by: Marcel Ziswiler <marcel.ziswiler@toradex.com>

---

 doc/board/toradex/verdin-am62.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

Comments

Heinrich Schuchardt Aug. 29, 2023, 7:48 a.m. UTC | #1
On 8/29/23 00:01, Marcel Ziswiler wrote:
> From: Marcel Ziswiler <marcel.ziswiler@toradex.com>
>
> Now with the update U-Boot wrappers having been sorted out, document
> their usage.
>
> Signed-off-by: Marcel Ziswiler <marcel.ziswiler@toradex.com>
>
> ---
>
>   doc/board/toradex/verdin-am62.rst | 14 ++++++++++++++
>   1 file changed, 14 insertions(+)
>
> diff --git a/doc/board/toradex/verdin-am62.rst b/doc/board/toradex/verdin-am62.rst
> index ecc7e0777cb..e8d90273288 100644
> --- a/doc/board/toradex/verdin-am62.rst
> +++ b/doc/board/toradex/verdin-am62.rst
> @@ -74,6 +74,20 @@ Flash to eMMC
>       => fatload mmc 1 ${loadaddr} u-boot.img
>       => mmc write ${loadaddr} 0x1400 0x2000
>
> +As a convenience, instead of having to remember all those addresses and sizes,
> +one may also use the update U-Boot wrappers:
> +
> +.. code-block:: bash
> +
> +    > tftpboot ${loadaddr} tiboot3-am62x-gp-verdin.bin
> +    > run update_tiboot3

I wonder what the prompt '>' refers to. The rest of the document uses
'=>' as U-Boot prompt.

To make copying easier consider using

.. prompt:: bash =>

The html rendered page will contain a => before each line but you would
not need to type it here.

Best regards

Heinrich

> +
> +    > tftpboot ${loadaddr} tispl.bin
> +    > run update_tispl
> +
> +    > tftpboot ${loadaddr} u-boot.img
> +    > run update_uboot
> +
>   Boot
>   ----
>
diff mbox series

Patch

diff --git a/doc/board/toradex/verdin-am62.rst b/doc/board/toradex/verdin-am62.rst
index ecc7e0777cb..e8d90273288 100644
--- a/doc/board/toradex/verdin-am62.rst
+++ b/doc/board/toradex/verdin-am62.rst
@@ -74,6 +74,20 @@  Flash to eMMC
     => fatload mmc 1 ${loadaddr} u-boot.img
     => mmc write ${loadaddr} 0x1400 0x2000
 
+As a convenience, instead of having to remember all those addresses and sizes,
+one may also use the update U-Boot wrappers:
+
+.. code-block:: bash
+
+    > tftpboot ${loadaddr} tiboot3-am62x-gp-verdin.bin
+    > run update_tiboot3
+
+    > tftpboot ${loadaddr} tispl.bin
+    > run update_tispl
+
+    > tftpboot ${loadaddr} u-boot.img
+    > run update_uboot
+
 Boot
 ----