lkml.org 
[lkml]   [2021]   [Mar]   [12]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
From
Subject[RFC PATCH] docs: Group arch-specific documentation under "CPU Architectures"
Date
To declutter the top-level table of contents (the side bar), this
patch reduces the architecture-specfic documentation to one top-level
item, "CPU Architectures".

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---

As a side effect, the TOC in index.html effectively gets one level of
detail less. This could be fixed by specifying ':maxdepth: 3'.
---
Documentation/arch.rst | 26 ++++++++++++++++++++++++++
Documentation/index.rst | 20 ++------------------
2 files changed, 28 insertions(+), 18 deletions(-)
create mode 100644 Documentation/arch.rst

diff --git a/Documentation/arch.rst b/Documentation/arch.rst
new file mode 100644
index 0000000000000..f10bd32a5972e
--- /dev/null
+++ b/Documentation/arch.rst
@@ -0,0 +1,26 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+CPU Architectures
+=================
+
+These books provide programming details about architecture-specific
+implementation.
+
+.. toctree::
+ :maxdepth: 2
+
+ arm/index
+ arm64/index
+ ia64/index
+ m68k/index
+ mips/index
+ nios2/index
+ openrisc/index
+ parisc/index
+ powerpc/index
+ riscv/index
+ s390/index
+ sh/index
+ sparc/index
+ x86/index
+ xtensa/index
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 31f2adc8542dc..54ce34fd6fbda 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -149,27 +149,11 @@ Architecture-agnostic documentation
Architecture-specific documentation
-----------------------------------

-These books provide programming details about architecture-specific
-implementation.
-
.. toctree::
:maxdepth: 2

- arm/index
- arm64/index
- ia64/index
- m68k/index
- mips/index
- nios2/index
- openrisc/index
- parisc/index
- powerpc/index
- riscv/index
- s390/index
- sh/index
- sparc/index
- x86/index
- xtensa/index
+ arch
+

Other documentation
-------------------
--
2.30.1
\
 
 \ /
  Last update: 2021-03-12 16:30    [W:0.050 / U:0.164 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site