| Message ID | 20190423162932.21428-16-changbin.du@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Delegated to: | Bjorn Helgaas |
| Headers | show |
| Series | Include linux ACPI/PCI/X86 docs into Sphinx TOC tree | expand |
Em Wed, 24 Apr 2019 00:28:44 +0800 Changbin Du <changbin.du@gmail.com> escreveu: > 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} | 28 +++++++++++-------- > Documentation/firmware-guide/acpi/index.rst | 1 + > 2 files changed, 17 insertions(+), 12 deletions(-) > rename Documentation/{acpi/dsd/data-node-references.txt => firmware-guide/acpi/dsd/data-node-references.rst} (79%) > > diff --git a/Documentation/acpi/dsd/data-node-references.txt b/Documentation/firmware-guide/acpi/dsd/data-node-references.rst > similarity index 79% > rename from Documentation/acpi/dsd/data-node-references.txt > rename to Documentation/firmware-guide/acpi/dsd/data-node-references.rst > index c3871565c8cf..79c5368eaecf 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,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>, Hmm... on the previous patch, you replaced <URL:some_url> by some_url, with makes sense. Please do the same here and on other patches on this series with a similar way to describe URLs. > 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 Thanks, Mauro
On Tue, Apr 23, 2019 at 06:17:48PM -0300, Mauro Carvalho Chehab wrote: > Em Wed, 24 Apr 2019 00:28:44 +0800 > Changbin Du <changbin.du@gmail.com> escreveu: > > > 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} | 28 +++++++++++-------- > > Documentation/firmware-guide/acpi/index.rst | 1 + > > 2 files changed, 17 insertions(+), 12 deletions(-) > > rename Documentation/{acpi/dsd/data-node-references.txt => firmware-guide/acpi/dsd/data-node-references.rst} (79%) > > > > diff --git a/Documentation/acpi/dsd/data-node-references.txt b/Documentation/firmware-guide/acpi/dsd/data-node-references.rst > > similarity index 79% > > rename from Documentation/acpi/dsd/data-node-references.txt > > rename to Documentation/firmware-guide/acpi/dsd/data-node-references.rst > > index c3871565c8cf..79c5368eaecf 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,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>, > > Hmm... on the previous patch, you replaced <URL:some_url> by some_url, > with makes sense. Please do the same here and on other patches on > this series with a similar way to describe URLs. > Done, thanks. > > 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 > > > > Thanks, > Mauro
diff --git a/Documentation/acpi/dsd/data-node-references.txt b/Documentation/firmware-guide/acpi/dsd/data-node-references.rst similarity index 79% rename from Documentation/acpi/dsd/data-node-references.txt rename to Documentation/firmware-guide/acpi/dsd/data-node-references.rst index c3871565c8cf..79c5368eaecf 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,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/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
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} | 28 +++++++++++-------- Documentation/firmware-guide/acpi/index.rst | 1 + 2 files changed, 17 insertions(+), 12 deletions(-) rename Documentation/{acpi/dsd/data-node-references.txt => firmware-guide/acpi/dsd/data-node-references.rst} (79%)