doc: board: Convert i.MX6ULL EVK README to reST
authorPeng Fan <peng.fan@nxp.com>
Wed, 14 Oct 2020 09:12:10 +0000 (17:12 +0800)
committerStefano Babic <sbabic@denx.de>
Sun, 1 Nov 2020 14:37:19 +0000 (15:37 +0100)
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
doc/board/freescale/mx6ullevk.rst [moved from board/freescale/mx6ullevk/README with 66% similarity]

index 046a839..313cf40 100644 (file)
@@ -17,3 +17,4 @@ Freescale
    mx6sabreauto
    mx6sabresd
    mx6ul_14x14_evk
+   mx6ullevk
similarity index 66%
rename from board/freescale/mx6ullevk/README
rename to doc/board/freescale/mx6ullevk.rst
index 47a35f6..a26248a 100644 (file)
@@ -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).