public inbox for u-boot@lists.denx.de
 help / color / mirror / Atom feed
From: Bin Meng <bmeng.cn@gmail.com>
To: u-boot@lists.denx.de
Subject: [U-Boot] [PATCH 47/50] doc: arch: Convert README.sh to reST
Date: Thu, 18 Jul 2019 00:34:32 -0700	[thread overview]
Message-ID: <1563435275-22326-48-git-send-email-bmeng.cn@gmail.com> (raw)
In-Reply-To: <1563435275-22326-1-git-send-email-bmeng.cn@gmail.com>

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/README.sh      |  97 ------------------------------------------------
 doc/arch/index.rst |   1 +
 doc/arch/sh.rst    | 106 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 107 insertions(+), 97 deletions(-)
 delete mode 100644 doc/README.sh
 create mode 100644 doc/arch/sh.rst

diff --git a/doc/README.sh b/doc/README.sh
deleted file mode 100644
index 766a8c8..0000000
--- a/doc/README.sh
+++ /dev/null
@@ -1,97 +0,0 @@
-
-U-Boot for Renesas SuperH
-	Last update 01/18/2008 by Nobuhiro Iwamatsu
-
-================================================================================
-0. What's this?
-	This file contains status information for the port of U-Boot to the
-	Renesas SuperH series of CPUs.
-
-================================================================================
-1. Overview
-	SuperH has an original boot loader. However, source code is dirty, and
-	maintenance is not done.
-	To improve sharing and the maintenance of the code, Nobuhiro Iwamatsu
-	started the porting to u-boot in 2007.
-
-================================================================================
-2. Supported CPUs
-
-	2.1. Renesas SH7750/SH7750R
-		This CPU has the SH4 core.
-
-	2.2. Renesas SH7722
-		This CPU has the SH4AL-DSP core.
-
-	2.3. Renesas SH7780
-		This CPU has the SH4A core.
-
-================================================================================
-3. Supported Boards
-
-	3.1. Hitachi UL MS7750SE01/MS7750RSE01
-		Board specific code is in board/ms7750se
-		To use this board, type "make ms7750se_config".
-		Support devices are :
-			- SCIF
-			- SDRAM
-			- NOR Flash
-			- Marubun PCMCIA
-
-	3.2. Hitachi UL MS7722SE01
-		Board specific code is in board/ms7722se
-		To use this board, type "make ms7722se_config".
-		Support devices are :
-			- SCIF
-			- SDRAM
-			- NOR Flash
-			- Marubun PCMCIA
-			- SMC91x ethernet
-
-	3.2. Hitachi UL MS7720ERP01
-		Board specific code is in board/ms7720se
-		To use this board, type "make ms7720se_config".
-		Support devices are :
-			- SCIF
-			- SDRAM
-			- NOR Flash
-			- Marubun PCMCIA
-
-	3.3. Renesas R7780MP
-		Board specific code is in board/r7780mp
-		To use this board, type "make r7780mp_config".
-		Support devices are :
-			- SCIF
-			- DDR-SDRAM
-			- NOR Flash
-			- Compact Flash
-			- ASIX ethernet
-			- SH7780 PCI bridge
-			- RTL8110 ethernet
-
-	** README **
-		In SuperH, S-record and binary of made u-boot work on the memory.
-		When u-boot is written in the flash, it is necessary to change the
-		address by using 'objcopy'.
-		ex) shX-linux-objcopy -Ibinary -Osrec u-boot.bin u-boot.flash.srec
-
-================================================================================
-4. Compiler
-	You can use the following of u-boot to compile.
-		- SuperH Linux Open site
-			http://www.superh-linux.org/
-		- KPIT GNU tools
-			http://www.kpitgnutools.com/
-
-================================================================================
-5. Future
-	I plan to support the following CPUs and boards.
-		5.1. CPUs
-			- SH7751R(SH4)
-
-		5.2. Boards
-			- Many boards ;-)
-
-================================================================================
-Copyright (c) 2007,2008
-    Nobuhiro Iwamatsu <iwamatsu@nigaur.org>
diff --git a/doc/arch/index.rst b/doc/arch/index.rst
index ee90ec1..d24662e 100644
--- a/doc/arch/index.rst
+++ b/doc/arch/index.rst
@@ -12,4 +12,5 @@ Architecture-specific doc
    mips
    nds32
    nios2
+   sh
    x86
diff --git a/doc/arch/sh.rst b/doc/arch/sh.rst
new file mode 100644
index 0000000..3a3f92d
--- /dev/null
+++ b/doc/arch/sh.rst
@@ -0,0 +1,106 @@
+.. SPDX-License-Identifier: GPL-2.0+
+.. Copyright (c) 2007,2008 Nobuhiro Iwamatsu <iwamatsu@nigaur.org>
+
+SuperH
+======
+
+What's this?
+------------
+This file contains status information for the port of U-Boot to the
+Renesas SuperH series of CPUs.
+
+Overview
+--------
+SuperH has an original boot loader. However, source code is dirty, and
+maintenance is not done. To improve sharing and the maintenance of the code,
+Nobuhiro Iwamatsu started the porting to U-Boot in 2007.
+
+Supported CPUs
+--------------
+
+Renesas SH7750/SH7750R
+^^^^^^^^^^^^^^^^^^^^^^
+This CPU has the SH4 core.
+
+Renesas SH7722
+^^^^^^^^^^^^^^
+This CPU has the SH4AL-DSP core.
+
+Renesas SH7780
+^^^^^^^^^^^^^^
+This CPU has the SH4A core.
+
+Supported Boards
+----------------
+
+Hitachi UL MS7750SE01/MS7750RSE01
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Board specific code is in board/ms7750se
+To use this board, type "make ms7750se_config".
+Support devices are:
+
+   - SCIF
+   - SDRAM
+   - NOR Flash
+   - Marubun PCMCIA
+
+Hitachi UL MS7722SE01
+^^^^^^^^^^^^^^^^^^^^^
+Board specific code is in board/ms7722se
+To use this board, type "make ms7722se_config".
+Support devices are:
+
+   - SCIF
+   - SDRAM
+   - NOR Flash
+   - Marubun PCMCIA
+   - SMC91x ethernet
+
+Hitachi UL MS7720ERP01
+^^^^^^^^^^^^^^^^^^^^^^
+Board specific code is in board/ms7720se
+To use this board, type "make ms7720se_config".
+Support devices are:
+
+   - SCIF
+   - SDRAM
+   - NOR Flash
+   - Marubun PCMCIA
+
+Renesas R7780MP
+^^^^^^^^^^^^^^^
+Board specific code is in board/r7780mp
+To use this board, type "make r7780mp_config".
+Support devices are:
+
+   - SCIF
+   - DDR-SDRAM
+   - NOR Flash
+   - Compact Flash
+   - ASIX ethernet
+   - SH7780 PCI bridge
+   - RTL8110 ethernet
+
+In SuperH, S-record and binary of made u-boot work on the memory.
+When u-boot is written in the flash, it is necessary to change the
+address by using 'objcopy'::
+
+   ex) shX-linux-objcopy -Ibinary -Osrec u-boot.bin u-boot.flash.srec
+
+Compiler
+--------
+You can use the following of u-boot to compile.
+   - `SuperH Linux Open site <http://www.superh-linux.org/>`_
+   - `KPIT GNU tools <http://www.kpitgnutools.com/>`_
+
+Future
+------
+I plan to support the following CPUs and boards.
+
+CPUs
+^^^^
+- SH7751R(SH4)
+
+Boards
+^^^^^^
+Many boards ;-)
-- 
2.7.4

  parent reply	other threads:[~2019-07-18  7:34 UTC|newest]

Thread overview: 66+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-07-18  7:33 [U-Boot] [PATCH 00/50] doc: Shape into useful HTML docs Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 01/50] doc: Move existing rst files into api sub-directory Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 02/50] doc: Add top-level description about U-Boot documentation Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 03/50] doc: Add driver-model to Sphinx TOC tree Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 04/50] doc: driver-model: Convert README.txt to reST Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 05/50] doc: driver-model: Convert MIGRATION.txt " Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 06/50] doc: driver-model: Convert fdt-fixup.txt " Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 07/50] doc: driver-model: Convert fs_firmware_loader.txt " Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 08/50] doc: driver-model: Convert i2c-howto.txt " Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 09/50] doc: driver-model: Convert livetree.txt " Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 10/50] doc: driver-model: Convert of-plat.txt " Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 11/50] doc: driver-model: Convert pci-info.txt " Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 12/50] doc: driver-model: Convert pmic-framework.txt " Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 13/50] doc: driver-model: Convert remoteproc-framework.txt " Bin Meng
2019-07-18  7:33 ` [U-Boot] [PATCH 14/50] doc: driver-model: Convert serial-howto.txt " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 15/50] doc: driver-model: Convert spi-howto.txt " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 16/50] doc: driver-model: Convert usb-info.txt " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 17/50] doc: Add architecture specific info to Sphinx TOC tree Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 18/50] doc: arch: Convert README.mips to reST Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 19/50] doc: Add board specific info to Sphinx TOC tree Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 20/50] doc: board: Add Intel Crown Bay board doc Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 21/50] doc: board: Add Intel Bay Trail based board docs Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 22/50] doc: board: Add Intel Cherry Hill board doc Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 23/50] doc: board: Add Intel Cougar Canyon 2 " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 24/50] doc: board: Add Intel Edison " Bin Meng
2019-07-18 18:27   ` Andy Shevchenko
2019-07-18  7:34 ` [U-Boot] [PATCH 25/50] doc: board: Add Intel Galileo " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 26/50] doc: board: Add Google Chromebook Link " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 27/50] doc: board: Add Google Chromebook Samus " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 28/50] doc: board: Add coreboot " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 29/50] doc: board: Add QEMU x86 " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 30/50] doc: board: Convert README.qemu-arm to reST Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 31/50] doc: board: Convert README.qemu-riscv " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 32/50] doc: board: Convert README.qemu-mips " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 33/50] doc: board: Add AndesTech ax25-ae350 board doc Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 34/50] doc: board: Convert README.ag101p to reST Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 35/50] doc: board: Convert README.sifive-fu540 " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 36/50] doc: board: Convert README.sh7752evb " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 37/50] doc: board: Convert README.sh7753evb " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 38/50] doc: board: Convert README.at91 " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 39/50] doc: board: Convert README.b4860qds " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 40/50] doc: board: Convert README.zynq " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 41/50] doc: arch: Convert README.x86 " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 42/50] doc: arch: Convert README.arm64 " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 43/50] doc: arch: Convert README.NDS32 " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 44/50] doc: arch: Convert README.nios2 " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 45/50] doc: arch: Convert README.ARC " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 46/50] doc: arch: Convert README.m68k " Bin Meng
2019-07-18  7:34 ` Bin Meng [this message]
2019-07-18  7:34 ` [U-Boot] [PATCH 48/50] doc: arch: Convert README.sandbox " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 49/50] doc: arch: Convert README.xtensa " Bin Meng
2019-07-18  7:34 ` [U-Boot] [PATCH 50/50] doc: Remove README.blackfin Bin Meng
2019-07-23  6:20 ` [U-Boot] [PATCH 00/50] doc: Shape into useful HTML docs Bin Meng
2019-07-23 15:00   ` Wolfgang Denk
2019-07-23 15:29     ` Tom Rini
2019-07-24  4:59       ` Bin Meng
2019-07-24  4:53     ` Bin Meng
2019-07-24  7:08       ` Wolfgang Denk
2019-07-24  7:13         ` Bin Meng
2019-07-24 14:14 ` Tom Rini
2019-07-24 14:16   ` Bin Meng
2019-07-24 14:18     ` Tom Rini
2019-07-24 19:30       ` Heinrich Schuchardt
2019-07-24 20:05 ` Tom Rini
2019-07-25 18:31 ` Heinrich Schuchardt
2019-07-26  1:54   ` Bin Meng

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1563435275-22326-48-git-send-email-bmeng.cn@gmail.com \
    --to=bmeng.cn@gmail.com \
    --cc=u-boot@lists.denx.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox