| Message ID | 20210312152804.2110703-1-j.neuschaefer@gmx.net (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [RFC] docs: Group arch-specific documentation under "CPU Architectures" | expand |
Jonathan Neuschäfer <j.neuschaefer@gmx.net> writes: > 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 I've badly wanted to clean up that page for a long time; this is a step in that direction, so I'm happy to see it. Applied, thanks. And no, we need *less* detail on the front page, not more, so no need to bring all that back. Thanks, jon
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 -------------------
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 -- 2.30.1