From e1c1364f3c22bd97bec315bc53161017f701a15a Mon Sep 17 00:00:00 2001
From: Bin Meng <bmeng.cn@gmail.com>
Date: Thu, 18 Jul 2019 00:34:34 -0700
Subject: [PATCH] doc: arch: Convert README.xtensa to reST
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 | 1 +
doc/{README.xtensa => arch/xtensa.rst} | 24 +++++++++++++-----------
2 files changed, 14 insertions(+), 11 deletions(-)
rename doc/{README.xtensa => arch/xtensa.rst} (90%)
diff --git a/doc/arch/index.rst b/doc/arch/index.rst
index 2980b77dec..369d8eeb6d 100644
--- a/doc/arch/index.rst
+++ b/doc/arch/index.rst
@@ -15,3 +15,4 @@ Architecture-specific doc
sandbox
sh
x86
+ xtensa
diff --git a/doc/README.xtensa b/doc/arch/xtensa.rst
similarity index 90%
rename from doc/README.xtensa
rename to doc/arch/xtensa.rst
index 406858226f..176410d96b 100644
--- a/doc/README.xtensa
+++ b/doc/arch/xtensa.rst
@@ -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
--
2.39.5