[U-Boot,31/50] doc: board: Convert README.qemu-riscv to reST
diff mbox series

Message ID 1563435275-22326-32-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>
---

 doc/board/emulation/index.rst                       |  1 +
 .../emulation/qemu-riscv.rst}                       | 21 ++++++++++++---------
 2 files changed, 13 insertions(+), 9 deletions(-)
 rename doc/{README.qemu-riscv => board/emulation/qemu-riscv.rst} (82%)

Patch
diff mbox series

diff --git a/doc/board/emulation/index.rst b/doc/board/emulation/index.rst
index a2b1a60..7537179 100644
--- a/doc/board/emulation/index.rst
+++ b/doc/board/emulation/index.rst
@@ -7,4 +7,5 @@  Emulation
    :maxdepth: 2
 
    qemu-arm
+   qemu-riscv
    qemu-x86
diff --git a/doc/README.qemu-riscv b/doc/board/emulation/qemu-riscv.rst
similarity index 82%
rename from doc/README.qemu-riscv
rename to doc/board/emulation/qemu-riscv.rst
index e2e4804..2148334 100644
--- a/doc/README.qemu-riscv
+++ b/doc/board/emulation/qemu-riscv.rst
@@ -1,9 +1,8 @@ 
-# SPDX-License-Identifier: GPL-2.0+
-#
-# Copyright (C) 2018, Bin Meng <bmeng.cn@gmail.com>
+.. SPDX-License-Identifier: GPL-2.0+
+.. Copyright (C) 2018, Bin Meng <bmeng.cn@gmail.com>
 
-U-Boot on QEMU's 'virt' machine on RISC-V
-=========================================
+QEMU RISC-V
+===========
 
 QEMU for RISC-V supports a special 'virt' machine designed for emulation and
 virtualization purposes. This document describes how to run U-Boot under it.
@@ -19,11 +18,13 @@  Building U-Boot
 ---------------
 Set the CROSS_COMPILE environment variable as usual, and run:
 
-- For 32-bit RISC-V:
+- For 32-bit RISC-V::
+
     make qemu-riscv32_defconfig
     make
 
-- For 64-bit RISC-V:
+- For 64-bit RISC-V::
+
     make qemu-riscv64_defconfig
     make
 
@@ -31,10 +32,12 @@  Running U-Boot
 --------------
 The minimal QEMU command line to get U-Boot up and running is:
 
-- For 32-bit RISC-V:
+- For 32-bit RISC-V::
+
     qemu-system-riscv32 -nographic -machine virt -kernel u-boot
 
-- For 64-bit RISC-V:
+- For 64-bit RISC-V::
+
     qemu-system-riscv64 -nographic -machine virt -kernel u-boot
 
 The commands above create targets with 128MiB memory by default.