From: Changbin Du <changbin.du@gmail.com>
To: rjw@rjwysocki.net, Jonathan Corbet <corbet@lwn.net>
Cc: Bjorn Helgaas <bhelgaas@google.com>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
fenghua.yu@intel.com, linuxppc-dev@lists.ozlabs.org,
linux-acpi@vger.kernel.org, linux-gpio@vger.kernel.org,
mchehab+samsung@kernel.org, Changbin Du <changbin.du@gmail.com>
Subject: [PATCH v6 01/24] Documentation: add Linux ACPI to Sphinx TOC tree
Date: Thu, 25 Apr 2019 23:30:54 +0800 [thread overview]
Message-ID: <20190425153117.16057-2-changbin.du@gmail.com> (raw)
In-Reply-To: <20190425153117.16057-1-changbin.du@gmail.com>
Add below index.rst files for ACPI subsystem. More docs will be added later.
o admin-guide/acpi/index.rst
o driver-api/acpi/index.rst
o firmware-guide/index.rst
Signed-off-by: Changbin Du <changbin.du@gmail.com>
Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/admin-guide/acpi/index.rst | 10 ++++++++++
Documentation/admin-guide/index.rst | 1 +
Documentation/driver-api/acpi/index.rst | 7 +++++++
Documentation/driver-api/index.rst | 1 +
Documentation/firmware-guide/acpi/index.rst | 9 +++++++++
Documentation/firmware-guide/index.rst | 13 +++++++++++++
Documentation/index.rst | 10 ++++++++++
7 files changed, 51 insertions(+)
create mode 100644 Documentation/admin-guide/acpi/index.rst
create mode 100644 Documentation/driver-api/acpi/index.rst
create mode 100644 Documentation/firmware-guide/acpi/index.rst
create mode 100644 Documentation/firmware-guide/index.rst
diff --git a/Documentation/admin-guide/acpi/index.rst b/Documentation/admin-guide/acpi/index.rst
new file mode 100644
index 000000000000..3e041206089d
--- /dev/null
+++ b/Documentation/admin-guide/acpi/index.rst
@@ -0,0 +1,10 @@
+============
+ACPI Support
+============
+
+Here we document in detail how to interact with various mechanisms in
+the Linux ACPI support.
+
+.. toctree::
+ :maxdepth: 1
+
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index 0a491676685e..5b8286fdd91b 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -77,6 +77,7 @@ configure specific aspects of kernel behavior to your liking.
LSM/index
mm/index
perf-security
+ acpi/index
.. only:: subproject and html
diff --git a/Documentation/driver-api/acpi/index.rst b/Documentation/driver-api/acpi/index.rst
new file mode 100644
index 000000000000..898b0c60671a
--- /dev/null
+++ b/Documentation/driver-api/acpi/index.rst
@@ -0,0 +1,7 @@
+============
+ACPI Support
+============
+
+.. toctree::
+ :maxdepth: 2
+
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index c0b600ed9961..aa87075c7846 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -56,6 +56,7 @@ available subsections can be seen below.
slimbus
soundwire/index
fpga/index
+ acpi/index
.. only:: subproject and html
diff --git a/Documentation/firmware-guide/acpi/index.rst b/Documentation/firmware-guide/acpi/index.rst
new file mode 100644
index 000000000000..0ec7d072ba22
--- /dev/null
+++ b/Documentation/firmware-guide/acpi/index.rst
@@ -0,0 +1,9 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+============
+ACPI Support
+============
+
+.. toctree::
+ :maxdepth: 1
+
diff --git a/Documentation/firmware-guide/index.rst b/Documentation/firmware-guide/index.rst
new file mode 100644
index 000000000000..5355784ca0a2
--- /dev/null
+++ b/Documentation/firmware-guide/index.rst
@@ -0,0 +1,13 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+===============================
+The Linux kernel firmware guide
+===============================
+
+This section describes the ACPI subsystem in Linux from firmware perspective.
+
+.. toctree::
+ :maxdepth: 1
+
+ acpi/index
+
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 80a421cb935e..fdfa85c56a50 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -35,6 +35,16 @@ trying to get it to work optimally on a given system.
admin-guide/index
+Firmware-related documentation
+------------------------------
+The following holds information on the kernel's expectations regarding the
+platform firmwares.
+
+.. toctree::
+ :maxdepth: 2
+
+ firmware-guide/index
+
Application-developer documentation
-----------------------------------
--
2.20.1
next prev parent reply other threads:[~2019-04-25 15:31 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-25 15:30 [PATCH v6 00/24] Include linux ACPI docs into Sphinx TOC tree Changbin Du
2019-04-25 15:30 ` Changbin Du [this message]
2019-04-25 15:30 ` [PATCH v6 02/24] Documentation: ACPI: move namespace.txt to firmware-guide/acpi and convert to reST Changbin Du
2019-04-25 15:30 ` [PATCH v6 03/24] Documentation: ACPI: move enumeration.txt " Changbin Du
2019-04-25 15:30 ` [PATCH v6 04/24] Documentation: ACPI: move osi.txt " Changbin Du
2019-04-25 15:30 ` [PATCH v6 05/24] Documentation: ACPI: move linuxized-acpica.txt to driver-api/acpi " Changbin Du
2019-04-25 15:30 ` [PATCH v6 06/24] Documentation: ACPI: move scan_handlers.txt " Changbin Du
2019-04-25 15:31 ` [PATCH v6 07/24] Documentation: ACPI: move DSD-properties-rules.txt to firmware-guide/acpi and covert " Changbin Du
2019-04-25 15:31 ` [PATCH v6 08/24] Documentation: ACPI: move gpio-properties.txt to firmware-guide/acpi and convert " Changbin Du
2019-04-25 15:31 ` [PATCH v6 09/24] Documentation: ACPI: move method-customizing.txt " Changbin Du
2019-04-25 15:31 ` [PATCH v6 10/24] Documentation: ACPI: move initrd_table_override.txt to admin-guide/acpi " Changbin Du
2019-04-25 15:31 ` [PATCH v6 11/24] Documentation: ACPI: move dsdt-override.txt " Changbin Du
2019-04-25 15:31 ` [PATCH v6 12/24] Documentation: ACPI: move i2c-muxes.txt to firmware-guide/acpi " Changbin Du
2019-04-25 15:31 ` [PATCH v6 13/24] Documentation: ACPI: move acpi-lid.txt " Changbin Du
2019-04-25 15:31 ` [PATCH v6 14/24] Documentation: ACPI: move dsd/graph.txt " Changbin Du
2019-04-25 15:31 ` [PATCH v6 15/24] Documentation: ACPI: move dsd/data-node-references.txt " Changbin Du
2019-04-25 15:31 ` [PATCH v6 16/24] Documentation: ACPI: move debug.txt " Changbin Du
2019-04-25 15:31 ` [PATCH v6 17/24] Documentation: ACPI: move method-tracing.txt to firmware-guide/acpi and convert to rsST Changbin Du
2019-04-25 15:31 ` [PATCH v6 18/24] Documentation: ACPI: move aml-debugger.txt to firmware-guide/acpi and convert to reST Changbin Du
2019-04-25 15:31 ` [PATCH v6 19/24] Documentation: ACPI: move apei/output_format.txt " Changbin Du
2019-04-25 15:31 ` [PATCH v6 20/24] Documentation: ACPI: move apei/einj.txt " Changbin Du
2019-04-25 15:31 ` [PATCH v6 21/24] Documentation: ACPI: move cppc_sysfs.txt to admin-guide/acpi " Changbin Du
2019-04-25 15:31 ` [PATCH v6 22/24] Documentation: ACPI: move lpit.txt to firmware-guide/acpi " Changbin Du
2019-04-25 15:31 ` [PATCH v6 23/24] Documentation: ACPI: move ssdt-overlays.txt to admin-guide/acpi " Changbin Du
2019-04-25 15:31 ` [PATCH v6 24/24] Documentation: ACPI: move video_extension.txt to firmware-guide/acpi " Changbin Du
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=20190425153117.16057-2-changbin.du@gmail.com \
--to=changbin.du@gmail.com \
--cc=bhelgaas@google.com \
--cc=corbet@lwn.net \
--cc=fenghua.yu@intel.com \
--cc=linux-acpi@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-gpio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linuxppc-dev@lists.ozlabs.org \
--cc=mchehab+samsung@kernel.org \
--cc=rjw@rjwysocki.net \
/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;
as well as URLs for NNTP newsgroup(s).