]> git.dujemihanovic.xyz Git - u-boot.git/commitdiff
doc: arch: Convert README.xtensa to reST
authorBin Meng <bmeng.cn@gmail.com>
Thu, 18 Jul 2019 07:34:34 +0000 (00:34 -0700)
committerTom Rini <trini@konsulko.com>
Wed, 24 Jul 2019 14:10:12 +0000 (10:10 -0400)
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/arch/index.rst
doc/arch/xtensa.rst [moved from doc/README.xtensa with 90% similarity]

index 2980b77dec1b2e10143854f2b809b0a0cdbd87f0..369d8eeb6d1c522cf7463934f509245021a4494f 100644 (file)
@@ -15,3 +15,4 @@ Architecture-specific doc
    sandbox
    sh
    x86
+   xtensa
similarity index 90%
rename from doc/README.xtensa
rename to doc/arch/xtensa.rst
index 406858226fa15865f86c51183cc7fb3ac3e256c6..176410d96b94923f55560879118a9f68f765a757 100644 (file)
@@ -1,5 +1,7 @@
-U-Boot for the Xtensa Architecture
-==================================
+.. SPDX-License-Identifier: GPL-2.0+
+
+Xtensa
+======
 
 Xtensa Architecture and Diamond Cores
 -------------------------------------
@@ -35,15 +37,16 @@ directory. The name of that directory starts with 'arch-' followed by
 the name for the processor configuration, for example, arch-dc233c for
 the Diamond DC233 processor.
 
-    core.h     Definitions for the core itself.
+core.h:
+  Definitions for the core itself.
 
 The following files are part of the overlay but not used by U-Boot.
 
-    tie.h      Co-processors and custom extensions defined
-               in the Tensilica Instruction Extension (TIE)
-               language.
-    tie-asm.h  Assembly macros to access custom-defined registers
-               and states.
+tie.h:
+  Co-processors and custom extensions defined in the Tensilica Instruction
+  Extension (TIE) language.
+tie-asm.h:
+  Assembly macros to access custom-defined registers and states.
 
 
 Global Data Pointer, Exported Function Stubs, and the ABI
@@ -92,6 +95,5 @@ U-Boot for Xtensa provides a special memory exception handler that
 reports such access attempts and resets the board.
 
 
-------------------------------------------------------------------------------
-Chris Zankel
-Ross Morley
+.. Chris Zankel
+.. Ross Morley