linux-kernel - [RFC PATCH] docs: Group arch-specific documentation under "CPU Architectures"

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20210312152804.2110703-1-j.neuschaefer@gmx.net>
Date:   Fri, 12 Mar 2021 16:28:03 +0100
From:   Jonathan Neuschäfer <j.neuschaefer@....net>
To:     linux-doc@...r.kernel.org
Cc:     linux-arch@...r.kernel.org,
        Jonathan Neuschäfer <j.neuschaefer@....net>,
        Jonathan Corbet <corbet@....net>,
        Paul Walmsley <paul.walmsley@...ive.com>,
        Palmer Dabbelt <palmer@...belt.com>,
        Albert Ou <aou@...s.berkeley.edu>,
        linux-kernel@...r.kernel.org, linux-riscv@...ts.infradead.org
Subject: [RFC PATCH] docs: Group arch-specific documentation under "CPU Architectures"

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@....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