diff mbox series

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

Message ID 20201014091210.12113-13-peng.fan@nxp.com
State New
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>

---
 doc/board/freescale/index.rst                 |  1 +
 .../board/freescale/mx6ullevk.rst             | 29 +++++++++++++------
 2 files changed, 21 insertions(+), 9 deletions(-)
 rename board/freescale/mx6ullevk/README => doc/board/freescale/mx6ullevk.rst (66%)

-- 
2.28.0
diff mbox series

Patch

diff --git a/doc/board/freescale/index.rst b/doc/board/freescale/index.rst
index 046a839a52..313cf409a6 100644
--- a/doc/board/freescale/index.rst
+++ b/doc/board/freescale/index.rst
@@ -17,3 +17,4 @@  Freescale
    mx6sabreauto
    mx6sabresd
    mx6ul_14x14_evk
+   mx6ullevk
diff --git a/board/freescale/mx6ullevk/README b/doc/board/freescale/mx6ullevk.rst
similarity index 66%
rename from board/freescale/mx6ullevk/README
rename to doc/board/freescale/mx6ullevk.rst
index 47a35f61a2..a26248a1e3 100644
--- a/board/freescale/mx6ullevk/README
+++ b/doc/board/freescale/mx6ullevk.rst
@@ -1,26 +1,37 @@ 
+.. SPDX-License-Identifier: GPL-2.0+
+
+mx6ullevk
+=========
+
 How to use U-Boot on Freescale MX6ULL 14x14 EVK
-----------------------------------------------
+-----------------------------------------------
 
 - First make sure you have installed the dtc package (device tree compiler):
 
-$ sudo apt-get install device-tree-compiler
+.. code-block:: bash
+
+   $ sudo apt-get install device-tree-compiler
 
 - Build U-Boot for MX6ULL 14x14 EVK:
 
-$ make mrproper
-$ make mx6ull_14x14_evk_defconfig
-$ make
+.. code-block:: bash
+
+   $ make mrproper
+   $ make mx6ull_14x14_evk_defconfig
+   $ make
 
 This generates the u-boot-dtb.imx image in the current directory.
 
 - Flash the u-boot-dtb.imx image into the micro SD card:
 
-$ sudo dd if=u-boot-dtb.imx of=/dev/sdb bs=1K seek=1 conv=notrunc && sync
+.. code-block:: bash
+
+   $ sudo dd if=u-boot-dtb.imx of=/dev/sdb bs=1K seek=1 conv=notrunc && sync
 
-- Jumper settings:
+- Jumper settings::
 
-SW601: 0 0 1 0
-Sw602: 1 0
+   SW601: 0 0 1 0
+   Sw602: 1 0
 
 Where 0 means bottom position and 1 means top position (from the switch label
 numbers reference).