[U-Boot,34/50] doc: board: Convert README.ag101p to reST
diff mbox series

Message ID 1563435275-22326-35-git-send-email-bmeng.cn@gmail.com
State Accepted
Delegated to: Tom Rini
Headers show
Series
  • doc: Shape into useful HTML docs
Related show

Commit Message

Bin Meng July 18, 2019, 7:34 a.m. UTC
Convert plain text documentation to reStructuredText format and add
it to Sphinx TOC tree. No essential content change.

Signed-off-by: Bin Meng <bmeng.cn@gmail.com>
---

 .../AndesTech/adp-ag101p.rst}                      | 26 +++++++++++++---------
 1 file changed, 15 insertions(+), 11 deletions(-)
 rename doc/{README.ag101p => board/AndesTech/adp-ag101p.rst} (83%)

Patch
diff mbox series

diff --git a/doc/README.ag101p b/doc/board/AndesTech/adp-ag101p.rst
similarity index 83%
rename from doc/README.ag101p
rename to doc/board/AndesTech/adp-ag101p.rst
index 8fc0ac5..879eba0 100644
--- a/doc/README.ag101p
+++ b/doc/board/AndesTech/adp-ag101p.rst
@@ -1,18 +1,21 @@ 
-Andes Technology SoC AG101P
-===========================
+.. SPDX-License-Identifier: GPL-2.0+
+
+ADP-AG101P
+==========
+
+ADP-AG101P is the SoC with AG101 hardcore CPU.
+
+AG101P SoC
+----------
 
 AG101P is the mainline SoC produced by Andes Technology using N1213 CPU core
 with FPU and DDR contoller support.
 AG101P has integrated both AHB and APB bus and many periphals for application
 and product development.
 
-ADP-AG101P
-=========
-
-ADP-AG101P is the SoC with AG101 hardcore CPU.
 
 Configurations
-==============
+--------------
 
 CONFIG_MEM_REMAP:
 	Doing memory remap is essential for preparing some non-OS or RTOS
@@ -24,13 +27,14 @@  CONFIG_SKIP_LOWLEVEL_INIT:
 	in "include/configs/adp-ag101p.h".
 
 Build and boot steps
-====================
+--------------------
+
+Build:
 
-build:
 1. Prepare the toolchains and make sure the $PATH to toolchains is correct.
 2. Use `make adp-ag101p_defconfig` in u-boot root to build the image.
 
-Burn u-boot to SPI ROM:
-====================
+Burn U-Boot to SPI ROM
+----------------------
 
 This section will be added later.