* [PATCH 2/2] Documentation: Add arch-guide documentation
@ 2017-02-24 7:38 Steve Kowalik
0 siblings, 0 replies; only message in thread
From: Steve Kowalik @ 2017-02-24 7:38 UTC (permalink / raw)
To: linux-sh
Add the new SuperH interfaces RST into the documentation tree by adding
a new arch-guide.
Signed-off-by: Steve Kowalik <steven@wedontsleep.org>
---
Documentation/00-INDEX | 2 ++
Documentation/arch-guide/conf.py | 10 ++++++++++
Documentation/arch-guide/index.rst | 14 ++++++++++++++
Documentation/index.rst | 11 +++++++++++
4 files changed, 37 insertions(+)
create mode 100644 Documentation/arch-guide/conf.py
create mode 100644 Documentation/arch-guide/index.rst
diff --git a/Documentation/00-INDEX b/Documentation/00-INDEX
index c8a8eb1..64625d0 100644
--- a/Documentation/00-INDEX
+++ b/Documentation/00-INDEX
@@ -60,6 +60,8 @@ admin-guide/
- info related to Linux users and system admins.
aoe/
- description of AoE (ATA over Ethernet) along with config examples.
+arch-guide/
+ - info related to architecture-specific code.
arm/
- directory with info about Linux on the ARM architecture.
arm64/
diff --git a/Documentation/arch-guide/conf.py b/Documentation/arch-guide/conf.py
new file mode 100644
index 0000000..2ac424b
--- /dev/null
+++ b/Documentation/arch-guide/conf.py
@@ -0,0 +1,10 @@
+# -*- coding: utf-8; mode: python -*-
+
+project = 'Linux Kernel architecture-specific Documentation'
+
+tags.add("subproject")
+
+latex_documents = [
+ ('index', 'Linux Kernel architecture-specific Documentation',
+ 'The kernel development community', 'manual'),
+]
diff --git a/Documentation/arch-guide/index.rst b/Documentation/arch-guide/index.rst
new file mode 100644
index 0000000..1db4658
--- /dev/null
+++ b/Documentation/arch-guide/index.rst
@@ -0,0 +1,14 @@
+The Linux kernel architecture-specific documentation
+==========================
+
+The following is a collection of architecture-specific documentation for the
+different architectures that the kernel supports.
+
+SuperH
+------
+
+.. toctree::
+ :maxdepth: 1
+
+ ../sh/interfaces.rst
+
diff --git a/Documentation/index.rst b/Documentation/index.rst
index f6e641a..6b3f570 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -60,6 +60,17 @@ needed).
sound/index
crypto/index
+Architecture-specific documentation
+-----------------------------------
+
+These documents get into the details of architecture-specific code or
+interfaces.
+
+.. toctree::
+ :maxdepth: 2
+
+ arch-guide/index
+
Korean translations
-------------------
--
2.7.4
^ permalink raw reply related [flat|nested] only message in thread
only message in thread, other threads:[~2017-02-24 7:38 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2017-02-24 7:38 [PATCH 2/2] Documentation: Add arch-guide documentation Steve Kowalik
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).