From 75e4bd1389c831eafda525f08a7e4decb30e54f3 Mon Sep 17 00:00:00 2001
From: Huang Qi <huangqi3@xiaomi.com>
Date: Thu, 12 Sep 2024 15:58:18 +0800
Subject: [PATCH] docs: Migrate MPS board documentation

Migrate docs of MPS board from its board directory to
common Documentation place.

Signed-off-by: Huang Qi <huangqi3@xiaomi.com>
---
 .../arm/mps/boards/mps2-an500/index.rst       |  7 +--
 .../arm/mps/boards/mps3-an547/index.rst       | 54 +++++++++++++++++++
 Documentation/platforms/arm/mps/index.rst     | 12 +++++
 boards/arm/mps/mps3-an547/README.txt          | 47 ----------------
 4 files changed, 70 insertions(+), 50 deletions(-)
 rename boards/arm/mps/mps2-an500/README.txt => Documentation/platforms/arm/mps/boards/mps2-an500/index.rst (95%)
 create mode 100644 Documentation/platforms/arm/mps/boards/mps3-an547/index.rst
 create mode 100644 Documentation/platforms/arm/mps/index.rst
 delete mode 100644 boards/arm/mps/mps3-an547/README.txt

diff --git a/boards/arm/mps/mps2-an500/README.txt b/Documentation/platforms/arm/mps/boards/mps2-an500/index.rst
similarity index 95%
rename from boards/arm/mps/mps2-an500/README.txt
rename to Documentation/platforms/arm/mps/boards/mps2-an500/index.rst
index 99566eeb4e..09ef63250e 100644
--- a/boards/arm/mps/mps2-an500/README.txt
+++ b/Documentation/platforms/arm/mps/boards/mps2-an500/index.rst
@@ -1,5 +1,6 @@
-README.txt
-==========
+=================
+MPS2 AN500 Board
+=================
 
 This board configuration will use QEMU to emulate generic ARM v7-M series
 hardware platform and provides support for these devices:
@@ -21,7 +22,7 @@ Getting Started
 ===============
 
 1. Configuring and running
-  1.1 Single Core
+
    Configuring NuttX and compile:
    $ ./tools/configure.sh -l mps2-an500:nsh
    $ make
diff --git a/Documentation/platforms/arm/mps/boards/mps3-an547/index.rst b/Documentation/platforms/arm/mps/boards/mps3-an547/index.rst
new file mode 100644
index 0000000000..42e2cbe014
--- /dev/null
+++ b/Documentation/platforms/arm/mps/boards/mps3-an547/index.rst
@@ -0,0 +1,54 @@
+=================
+MPS3 AN547 Board
+=================
+
+The MPS3 AN547 board configuration uses QEMU to emulate a generic ARM v8-M series hardware platform and provides support for the following devices:
+
+ - ARM Generic Timer
+ - CMSDK UART controller
+
+Getting Started
+===============
+
+Configuring and Running
+-----------------------
+
+### Single Core
+
+1. **Configuring NuttX and Compiling:**
+
+   ```bash
+   $ ./tools/configure.sh -l mps3-an547:nsh
+   $ make
+   ```
+
+2. **Running with QEMU:**
+
+   ```bash
+   $ qemu-system-arm -M mps3-an547 -nographic -kernel nuttx.bin
+   ```
+
+Debugging with QEMU
+===================
+
+The NuttX ELF image can be debugged using QEMU.
+
+1. **Enable Debug Symbols:**
+
+   Ensure the following change is applied to `defconfig`:
+
+   ```bash
+   +CONFIG_DEBUG_SYMBOLS=y
+   ```
+
+2. **Run QEMU:**
+
+   ```bash
+   $ qemu-system-arm -M mps3-an547 -nographic -kernel nuttx.bin -S -s
+   ```
+
+3. **Run GDB with TUI:**
+
+   ```bash
+   $ arm-none-eabi-gdb -tui --eval-command='target remote localhost:1234' nuttx
+   ```
diff --git a/Documentation/platforms/arm/mps/index.rst b/Documentation/platforms/arm/mps/index.rst
new file mode 100644
index 0000000000..de480c4250
--- /dev/null
+++ b/Documentation/platforms/arm/mps/index.rst
@@ -0,0 +1,12 @@
+====
+MPS
+====
+
+Supported Boards
+================
+
+.. toctree::
+   :glob:
+   :maxdepth: 1
+
+   boards/*/*
diff --git a/boards/arm/mps/mps3-an547/README.txt b/boards/arm/mps/mps3-an547/README.txt
deleted file mode 100644
index 6334b5e575..0000000000
--- a/boards/arm/mps/mps3-an547/README.txt
+++ /dev/null
@@ -1,47 +0,0 @@
-README.txt
-==========
-
-This board configuration will use QEMU to emulate generic ARM v8-M series
-hardware platform and provides support for these devices:
-
- - ARM Generic Timer
- - CMSDK UART controller
-
-Contents
-========
-  - Getting Started
-  - Status
-  - Platform Features
-  - Debugging with QEMU
-  - FPU Support and Performance
-  - SMP Support
-  - References
-
-Getting Started
-===============
-
-1. Configuring and running
-  1.1 Single Core
-   Configuring NuttX and compile:
-   $ ./tools/configure.sh -l mps3-an547:nsh
-   $ make
-   Running with qemu
-   $ qemu-system-arm -M mps3-an547 -nographic -kernel nuttx.bin
-
-Debugging with QEMU
-===================
-
-The nuttx ELF image can be debugged with QEMU.
-
-1. To debug the nuttx (ELF) with symbols, make sure the following change have
-   applied to defconfig.
-
-+CONFIG_DEBUG_SYMBOLS=y
-
-2. Run QEMU(at shell terminal 1)
-
-   $ qemu-system-arm -M mps3-an547 -nographic -kernel nuttx.bin -S -s
-
-3. Run gdb with TUI, connect to QEMU, load nuttx and continue (at shell terminal 2)
-
-   $ arm-none-eabi-gdb -tui --eval-command='target remote localhost:1234' nuttx