diff mbox series

[V2,08/12] doc: board: Convert i.MXRT1050 EVK README to reST

Message ID 20201014091210.12113-9-peng.fan@nxp.com
State Accepted
Commit 9de1712d167b3b40cf9cf85f4a675fb0f225d228
Delegated to: Stefano Babic
Headers show
Series imx: doc update | expand

Commit Message

Peng Fan Oct. 14, 2020, 9:12 a.m. UTC 
Convert plain text documentation to reStructuredText format and add
it to Sphinx TOC tree. No essential content change.

Signed-off-by: Peng Fan <peng.fan@nxp.com>
---
 board/freescale/imxrt1050-evk/README  | 31 --------------------
 doc/board/freescale/imxrt1050-evk.rst | 41 +++++++++++++++++++++++++++
 doc/board/freescale/index.rst         |  1 +
 3 files changed, 42 insertions(+), 31 deletions(-)
 delete mode 100644 board/freescale/imxrt1050-evk/README
 create mode 100644 doc/board/freescale/imxrt1050-evk.rst

Comments

Stefano Babic Nov. 1, 2020, 2:39 p.m. UTC | #1 
> Convert plain text documentation to reStructuredText format and add
> it to Sphinx TOC tree. No essential content change.
> Signed-off-by: Peng Fan <peng.fan@nxp.com>
Applied to u-boot-imx, master, thanks !

Best regards,
Stefano Babic
diff mbox series

Patch

diff --git a/board/freescale/imxrt1050-evk/README b/board/freescale/imxrt1050-evk/README
deleted file mode 100644
index f321300246..0000000000
--- a/board/freescale/imxrt1050-evk/README
+++ /dev/null
@@ -1,31 +0,0 @@ 
-How to use U-Boot on NXP i.MXRT1050 EVK
------------------------------------------------
-
-- Build U-Boot for i.MXRT1050 EVK:
-
-$ make mrproper
-$ make imxrt1050-evk_defconfig
-$ make
-
-This will generate the SPL image called SPL and the u-boot.img.
-
-- Flash the SPL image into the micro SD card:
-
-sudo dd if=SPL of=/dev/sdX bs=1k seek=1 conv=notrunc; sync
-
-- Flash the u-boot.img image into the micro SD card:
-
-sudo dd if=u-boot.img of=/dev/sdX bs=1k seek=128 conv=notrunc; sync
-
-- Jumper settings:
-
-SW7: 1 0 1 0
-
-where 0 means bottom position and 1 means top position (from the
-switch label numbers reference).
-
-- Connect the USB cable between the EVK and the PC for the console.
-(The USB console connector is the one close the ethernet connector)
-
-- Insert the micro SD card in the board, power it up and U-Boot messages should
-come up.
diff --git a/doc/board/freescale/imxrt1050-evk.rst b/doc/board/freescale/imxrt1050-evk.rst
new file mode 100644
index 0000000000..c1fb48f0cd
--- /dev/null
+++ b/doc/board/freescale/imxrt1050-evk.rst
@@ -0,0 +1,41 @@ 
+.. SPDX-License-Identifier: GPL-2.0+
+
+imxrt1050-evk
+=============
+
+How to use U-Boot on NXP i.MXRT1050 EVK
+---------------------------------------
+
+- Build U-Boot for i.MXRT1050 EVK:
+
+.. code-block:: bash
+
+   $ make mrproper
+   $ make imxrt1050-evk_defconfig
+   $ make
+
+This will generate the SPL image called SPL and the u-boot.img.
+
+- Flash the SPL image into the micro SD card:
+
+.. code-block:: bash
+
+   $sudo dd if=SPL of=/dev/sdX bs=1k seek=1 conv=notrunc; sync
+
+- Flash the u-boot.img image into the micro SD card:
+
+.. code-block:: bash
+
+   $sudo dd if=u-boot.img of=/dev/sdX bs=1k seek=128 conv=notrunc; sync
+
+- Jumper settings::
+
+   SW7: 1 0 1 0
+
+where 0 means bottom position and 1 means top position (from the
+switch label numbers reference).
+
+- Connect the USB cable between the EVK and the PC for the console.
+  The USB console connector is the one close the ethernet connector
+
+- Insert the micro SD card in the board, power it up and U-Boot messages should come up.
diff --git a/doc/board/freescale/index.rst b/doc/board/freescale/index.rst
index 81c4826beb..c9d7411875 100644
--- a/doc/board/freescale/index.rst
+++ b/doc/board/freescale/index.rst
@@ -13,3 +13,4 @@  Freescale
    imx8mq_evk
    imx8qxp_mek
    imxrt1020-evk
+   imxrt1050-evk