linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Changbin Du <changbin.du@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: rjw@rjwysocki.net, lenb@kernel.org, linux-acpi@vger.kernel.org,
	linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
	Changbin Du <changbin.du@gmail.com>
Subject: [PATCH v2 15/24] acpi doc: convert acpi/dsd/data-node-references.txt to rst format
Date: Fri, 29 Mar 2019 08:11:26 +0800	[thread overview]
Message-ID: <20190329001135.15847-16-changbin.du@gmail.com> (raw)
In-Reply-To: <20190329001135.15847-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>
---
 ...eferences.txt => data-node-references.rst} | 28 +++++++++++--------
 Documentation/acpi/index.rst                  |  1 +
 2 files changed, 17 insertions(+), 12 deletions(-)
 rename Documentation/acpi/dsd/{data-node-references.txt => data-node-references.rst} (79%)

diff --git a/Documentation/acpi/dsd/data-node-references.txt b/Documentation/acpi/dsd/data-node-references.rst
similarity index 79%
rename from Documentation/acpi/dsd/data-node-references.txt
rename to Documentation/acpi/dsd/data-node-references.rst
index c3871565c8cf..79c5368eaecf 100644
--- a/Documentation/acpi/dsd/data-node-references.txt
+++ b/Documentation/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,10 +79,10 @@ 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>,
diff --git a/Documentation/acpi/index.rst b/Documentation/acpi/index.rst
index 40a628b2be21..b680fb13f445 100644
--- a/Documentation/acpi/index.rst
+++ b/Documentation/acpi/index.rst
@@ -10,6 +10,7 @@ Linux ACPI (Advanced Configuration and Power Interface)
    linuxized-acpica
    namespace
    dsd/graph
+   dsd/data-node-references
    enumeration
    osi
    DSD-properties-rules
-- 
2.20.1


  parent reply	other threads:[~2019-03-29  0:13 UTC|newest]

Thread overview: 38+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-29  0:11 [PATCH v2 00/24] Include linux ACPI docs into Sphinx TOC tree Changbin Du
2019-03-29  0:11 ` [PATCH v2 01/24] Documentation: add Linux ACPI to " Changbin Du
2019-03-30  9:51   ` Rafael J. Wysocki
2019-03-31  5:13     ` Changbin Du
2019-03-29  0:11 ` [PATCH v2 02/24] acpi doc: convert acpi/namespace.txt to rst format Changbin Du
2019-03-29  0:11 ` [PATCH v2 03/24] acpi doc: convert acpi/enumeration.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 04/24] acpi doc: convert acpi/osi.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 05/24] acpi doc: convert acpi/linuxized-acpica.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 06/24] acpi doc: convert acpi/scan_handlers.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 07/24] acpi doc: convert acpi/DSD-properties-rules.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 08/24] acpi doc: convert acpi/gpio-properties.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 09/24] acpi doc: convert acpi/method-customizing.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 10/24] acpi doc: convert acpi/initrd_table_override.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 11/24] acpi doc: convert acpi/dsdt-override.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 12/24] acpi doc: convert acpi/i2c-muxes.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 13/24] acpi doc: convert acpi/acpi-lid.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 14/24] acpi doc: convert acpi/dsd/graph.txt " Changbin Du
2019-03-29  0:11 ` Changbin Du [this message]
2019-03-29  0:11 ` [PATCH v2 16/24] acpi doc: convert acpi/debug.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 17/24] acpi doc: convert acpi/method-tracing.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 18/24] acpi doc: convert acpi/aml-debugger.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 19/24] acpi doc: convert acpi/apei/output_format.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 20/24] acpi doc: convert acpi/apei/einj.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 21/24] acpi doc: convert acpi/cppc_sysfs.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 22/24] acpi doc: convert acpi/lpit.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 23/24] acpi doc: convert acpi/ssdt-overlays.txt " Changbin Du
2019-03-29  0:11 ` [PATCH v2 24/24] acpi doc: convert acpi/video_extension.txt " Changbin Du
2019-03-30  9:41 ` [PATCH v2 00/24] Include linux ACPI docs into Sphinx TOC tree Rafael J. Wysocki
2019-04-02  8:25   ` Rafael J. Wysocki
2019-04-03 19:36     ` Jonathan Corbet
2019-04-03 20:40       ` Andy Shevchenko
2019-04-09 16:35         ` Rafael J. Wysocki
2019-04-05  2:44       ` Changbin Du
2019-04-09 16:17         ` Changbin Du
2019-04-09 16:42       ` Rafael J. Wysocki
2019-04-09 21:26         ` Jonathan Corbet
2019-04-09 21:44           ` Rafael J. Wysocki
2019-04-11 15:12             ` 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=20190329001135.15847-16-changbin.du@gmail.com \
    --to=changbin.du@gmail.com \
    --cc=corbet@lwn.net \
    --cc=lenb@kernel.org \
    --cc=linux-acpi@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.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).