| Message ID | 20190423162932.21428-7-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:35 +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> For the conversion itself: Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> > --- > Documentation/driver-api/acpi/index.rst | 1 + > .../acpi/scan_handlers.rst} | 24 ++++++++++++------- > 2 files changed, 16 insertions(+), 9 deletions(-) > rename Documentation/{acpi/scan_handlers.txt => driver-api/acpi/scan_handlers.rst} (90%) > > diff --git a/Documentation/driver-api/acpi/index.rst b/Documentation/driver-api/acpi/index.rst > index 12649947b19b..ace0008e54c2 100644 > --- a/Documentation/driver-api/acpi/index.rst > +++ b/Documentation/driver-api/acpi/index.rst > @@ -6,3 +6,4 @@ ACPI Support > :maxdepth: 2 > > linuxized-acpica > + scan_handlers > diff --git a/Documentation/acpi/scan_handlers.txt b/Documentation/driver-api/acpi/scan_handlers.rst > similarity index 90% > rename from Documentation/acpi/scan_handlers.txt > rename to Documentation/driver-api/acpi/scan_handlers.rst > index 3246ccf15992..7a197b3a33fc 100644 > --- a/Documentation/acpi/scan_handlers.txt > +++ b/Documentation/driver-api/acpi/scan_handlers.rst > @@ -1,7 +1,13 @@ > +.. SPDX-License-Identifier: GPL-2.0 > +.. include:: <isonum.txt> > + > +================== > ACPI Scan Handlers > +================== > + > +:Copyright: |copy| 2012, Intel Corporation > > -Copyright (C) 2012, Intel Corporation > -Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com> > +:Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com> > > During system initialization and ACPI-based device hot-add, the ACPI namespace > is scanned in search of device objects that generally represent various pieces > @@ -30,14 +36,14 @@ to configure that link so that the kernel can use it. > Those additional configuration tasks usually depend on the type of the hardware > component represented by the given device node which can be determined on the > basis of the device node's hardware ID (HID). They are performed by objects > -called ACPI scan handlers represented by the following structure: > +called ACPI scan handlers represented by the following structure:: > > -struct acpi_scan_handler { > - const struct acpi_device_id *ids; > - struct list_head list_node; > - int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id); > - void (*detach)(struct acpi_device *dev); > -}; > + struct acpi_scan_handler { > + const struct acpi_device_id *ids; > + struct list_head list_node; > + int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id); > + void (*detach)(struct acpi_device *dev); > + }; > > where ids is the list of IDs of device nodes the given handler is supposed to > take care of, list_node is the hook to the global list of ACPI scan handlers Thanks, Mauro
diff --git a/Documentation/driver-api/acpi/index.rst b/Documentation/driver-api/acpi/index.rst index 12649947b19b..ace0008e54c2 100644 --- a/Documentation/driver-api/acpi/index.rst +++ b/Documentation/driver-api/acpi/index.rst @@ -6,3 +6,4 @@ ACPI Support :maxdepth: 2 linuxized-acpica + scan_handlers diff --git a/Documentation/acpi/scan_handlers.txt b/Documentation/driver-api/acpi/scan_handlers.rst similarity index 90% rename from Documentation/acpi/scan_handlers.txt rename to Documentation/driver-api/acpi/scan_handlers.rst index 3246ccf15992..7a197b3a33fc 100644 --- a/Documentation/acpi/scan_handlers.txt +++ b/Documentation/driver-api/acpi/scan_handlers.rst @@ -1,7 +1,13 @@ +.. SPDX-License-Identifier: GPL-2.0 +.. include:: <isonum.txt> + +================== ACPI Scan Handlers +================== + +:Copyright: |copy| 2012, Intel Corporation -Copyright (C) 2012, Intel Corporation -Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com> +:Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com> During system initialization and ACPI-based device hot-add, the ACPI namespace is scanned in search of device objects that generally represent various pieces @@ -30,14 +36,14 @@ to configure that link so that the kernel can use it. Those additional configuration tasks usually depend on the type of the hardware component represented by the given device node which can be determined on the basis of the device node's hardware ID (HID). They are performed by objects -called ACPI scan handlers represented by the following structure: +called ACPI scan handlers represented by the following structure:: -struct acpi_scan_handler { - const struct acpi_device_id *ids; - struct list_head list_node; - int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id); - void (*detach)(struct acpi_device *dev); -}; + struct acpi_scan_handler { + const struct acpi_device_id *ids; + struct list_head list_node; + int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id); + void (*detach)(struct acpi_device *dev); + }; where ids is the list of IDs of device nodes the given handler is supposed to take care of, list_node is the hook to the global list of ACPI scan handlers
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> --- Documentation/driver-api/acpi/index.rst | 1 + .../acpi/scan_handlers.rst} | 24 ++++++++++++------- 2 files changed, 16 insertions(+), 9 deletions(-) rename Documentation/{acpi/scan_handlers.txt => driver-api/acpi/scan_handlers.rst} (90%)