From: "Jonathan Neuschäfer" <j.neuschaefer@gmx.net>
To: linux-doc@vger.kernel.org
Cc: linux-arch@vger.kernel.org,
"Jonathan Neuschäfer" <j.neuschaefer@gmx.net>,
"Jonathan Corbet" <corbet@lwn.net>,
"Paul Walmsley" <paul.walmsley@sifive.com>,
"Palmer Dabbelt" <palmer@dabbelt.com>,
"Albert Ou" <aou@eecs.berkeley.edu>,
linux-kernel@vger.kernel.org, linux-riscv@lists.infradead.org
Subject: [RFC PATCH] docs: Group arch-specific documentation under "CPU Architectures"
Date: Fri, 12 Mar 2021 16:28:03 +0100 [thread overview]
Message-ID: <20210312152804.2110703-1-j.neuschaefer@gmx.net> (raw)
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
next reply other threads:[~2021-03-12 15:29 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-12 15:28 Jonathan Neuschäfer [this message]
2021-03-15 19:52 ` Jonathan Corbet
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=20210312152804.2110703-1-j.neuschaefer@gmx.net \
--to=j.neuschaefer@gmx.net \
--cc=aou@eecs.berkeley.edu \
--cc=corbet@lwn.net \
--cc=linux-arch@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-riscv@lists.infradead.org \
--cc=palmer@dabbelt.com \
--cc=paul.walmsley@sifive.com \
/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
all inboxes | Powered by JetHome®