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 v5 14/23] Documentation: ACPI: move dsd/data-node-references.txt to firmware-guide/acpi and convert to reST
Date: Thu, 25 Apr 2019 01:52:57 +0800 [thread overview]
Message-ID: <20190424175306.25880-15-changbin.du@gmail.com> (raw)
In-Reply-To: <20190424175306.25880-1-changbin.du@gmail.com>
This converts the plain text documentation to reStructuredText format and
add it to Sphinx TOC tree. No essential content change.
Signed-off-by: Changbin Du <changbin.du@gmail.com>
---
.../acpi/dsd/data-node-references.rst} | 36 ++++++++++---------
Documentation/firmware-guide/acpi/index.rst | 1 +
2 files changed, 21 insertions(+), 16 deletions(-)
rename Documentation/{acpi/dsd/data-node-references.txt => firmware-guide/acpi/dsd/data-node-references.rst} (71%)
diff --git a/Documentation/acpi/dsd/data-node-references.txt b/Documentation/firmware-guide/acpi/dsd/data-node-references.rst
similarity index 71%
rename from Documentation/acpi/dsd/data-node-references.txt
rename to Documentation/firmware-guide/acpi/dsd/data-node-references.rst
index c3871565c8cf..1351984e767c 100644
--- a/Documentation/acpi/dsd/data-node-references.txt
+++ b/Documentation/firmware-guide/acpi/dsd/data-node-references.rst
@@ -1,9 +1,12 @@
-Copyright (C) 2018 Intel Corporation
-Author: Sakari Ailus <sakari.ailus@linux.intel.com>
-
+.. SPDX-License-Identifier: GPL-2.0
+.. include:: <isonum.txt>
+===================================
Referencing hierarchical data nodes
------------------------------------
+===================================
+
+:Copyright: |copy| 2018 Intel Corporation
+:Author: Sakari Ailus <sakari.ailus@linux.intel.com>
ACPI in general allows referring to device objects in the tree only.
Hierarchical data extension nodes may not be referred to directly, hence this
@@ -28,13 +31,14 @@ extension key.
Example
--------
+=======
- In the ASL snippet below, the "reference" _DSD property [2] contains a
- device object reference to DEV0 and under that device object, a
- hierarchical data extension key "node@1" referring to the NOD1 object
- and lastly, a hierarchical data extension key "anothernode" referring to
- the ANOD object which is also the final target node of the reference.
+In the ASL snippet below, the "reference" _DSD property [2] contains a
+device object reference to DEV0 and under that device object, a
+hierarchical data extension key "node@1" referring to the NOD1 object
+and lastly, a hierarchical data extension key "anothernode" referring to
+the ANOD object which is also the final target node of the reference.
+::
Device (DEV0)
{
@@ -75,15 +79,15 @@ Example
})
}
-Please also see a graph example in graph.txt .
+Please also see a graph example in :doc:`graph`.
References
-----------
+==========
[1] Hierarchical Data Extension UUID For _DSD.
- <URL:http://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf>,
- referenced 2018-07-17.
+<http://www.uefi.org/sites/default/files/resources/_DSD-hierarchical-data-extension-UUID-v1.1.pdf>,
+referenced 2018-07-17.
[2] Device Properties UUID For _DSD.
- <URL:http://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf>,
- referenced 2016-10-04.
+<http://www.uefi.org/sites/default/files/resources/_DSD-device-properties-UUID.pdf>,
+referenced 2016-10-04.
diff --git a/Documentation/firmware-guide/acpi/index.rst b/Documentation/firmware-guide/acpi/index.rst
index f81cfbcb6878..6d4e0df4f063 100644
--- a/Documentation/firmware-guide/acpi/index.rst
+++ b/Documentation/firmware-guide/acpi/index.rst
@@ -9,6 +9,7 @@ ACPI Support
namespace
dsd/graph
+ dsd/data-node-references
enumeration
osi
method-customizing
--
2.20.1
next prev parent reply other threads:[~2019-04-24 17:55 UTC|newest]
Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-24 17:52 [PATCH v5 00/23] Include linux ACPI docs into Sphinx TOC tree Changbin Du
2019-04-24 17:52 ` [PATCH v5 01/23] Documentation: ACPI: move namespace.txt to firmware-guide/acpi and convert to reST Changbin Du
2019-04-24 17:52 ` [PATCH v5 02/23] Documentation: ACPI: move enumeration.txt " Changbin Du
2019-04-24 17:52 ` [PATCH v5 03/23] Documentation: ACPI: move osi.txt " Changbin Du
2019-04-24 17:52 ` [PATCH v5 04/23] Documentation: ACPI: move linuxized-acpica.txt to driver-api/acpi " Changbin Du
2019-04-24 17:52 ` [PATCH v5 05/23] Documentation: ACPI: move scan_handlers.txt " Changbin Du
2019-04-24 17:52 ` [PATCH v5 06/23] Documentation: ACPI: move DSD-properties-rules.txt to firmware-guide/acpi and covert " Changbin Du
2019-04-24 17:52 ` [PATCH v5 07/23] Documentation: ACPI: move gpio-properties.txt to firmware-guide/acpi and convert " Changbin Du
2019-04-24 17:52 ` [PATCH v5 08/23] Documentation: ACPI: move method-customizing.txt " Changbin Du
2019-04-24 18:08 ` Mauro Carvalho Chehab
2019-04-24 17:52 ` [PATCH v5 09/23] Documentation: ACPI: move initrd_table_override.txt to admin-guide/acpi " Changbin Du
2019-04-24 17:52 ` [PATCH v5 10/23] Documentation: ACPI: move dsdt-override.txt " Changbin Du
2019-04-24 17:52 ` [PATCH v5 11/23] Documentation: ACPI: move i2c-muxes.txt to firmware-guide/acpi " Changbin Du
2019-04-24 17:52 ` [PATCH v5 12/23] Documentation: ACPI: move acpi-lid.txt " Changbin Du
2019-04-24 17:52 ` [PATCH v5 13/23] Documentation: ACPI: move dsd/graph.txt " Changbin Du
2019-04-24 17:52 ` Changbin Du [this message]
2019-04-24 18:10 ` [PATCH v5 14/23] Documentation: ACPI: move dsd/data-node-references.txt " Mauro Carvalho Chehab
2019-04-24 17:52 ` [PATCH v5 15/23] Documentation: ACPI: move debug.txt " Changbin Du
2019-04-24 17:52 ` [PATCH v5 16/23] Documentation: ACPI: move method-tracing.txt to firmware-guide/acpi and convert to rsST Changbin Du
2019-04-24 17:53 ` [PATCH v5 17/23] Documentation: ACPI: move aml-debugger.txt to firmware-guide/acpi and convert to reST Changbin Du
2019-04-24 17:53 ` [PATCH v5 18/23] Documentation: ACPI: move apei/output_format.txt " Changbin Du
2019-04-24 17:53 ` [PATCH v5 19/23] Documentation: ACPI: move apei/einj.txt " Changbin Du
2019-04-24 17:53 ` [PATCH v5 20/23] Documentation: ACPI: move cppc_sysfs.txt to admin-guide/acpi " Changbin Du
2019-04-24 18:12 ` Mauro Carvalho Chehab
2019-04-25 0:44 ` Changbin Du
2019-04-24 17:53 ` [PATCH v5 21/23] Documentation: ACPI: move lpit.txt to firmware-guide/acpi " Changbin Du
2019-04-24 17:53 ` [PATCH v5 22/23] Documentation: ACPI: move ssdt-overlays.txt to admin-guide/acpi " Changbin Du
2019-04-24 17:53 ` [PATCH v5 23/23] Documentation: ACPI: move video_extension.txt to firmware-guide/acpi " Changbin Du
2019-04-24 18:26 ` Mauro Carvalho Chehab
2019-04-25 8:44 ` [PATCH v5 00/23] Include linux ACPI docs into Sphinx TOC tree Rafael J. Wysocki
2019-04-25 15:20 ` Changbin Du
2019-05-01 10:15 ` Rafael J. Wysocki
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=20190424175306.25880-15-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).