On Wednesday, August 14, 2019 2:58:58 PM CEST Sakari Ailus wrote:
> Convert the LED documentation in text format into ReST.
>
> Signed-off-by: Sakari Ailus <sakari.ailus@xxxxxxxxxxxxxxx>
> ---
> .../acpi/dsd/leds.rst} | 20 +++++++++++++++----
> Documentation/firmware-guide/acpi/index.rst | 1 +
> 2 files changed, 17 insertions(+), 4 deletions(-)
> rename Documentation/{acpi/dsd/leds.txt => firmware-guide/acpi/dsd/leds.rst} (90%)
>
> diff --git a/Documentation/acpi/dsd/leds.txt b/Documentation/firmware-guide/acpi/dsd/leds.rst
> similarity index 90%
> rename from Documentation/acpi/dsd/leds.txt
> rename to Documentation/firmware-guide/acpi/dsd/leds.rst
> index cc58b1a574c5..946efe2b2936 100644
> --- a/Documentation/acpi/dsd/leds.txt
> +++ b/Documentation/firmware-guide/acpi/dsd/leds.rst
> @@ -1,4 +1,9 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +.. include:: <isonum.txt>
> +
> +========================================
> Describing and referring to LEDs in ACPI
> +========================================
>
> Individual LEDs are described by hierarchical data extension [6] nodes under the
> device node, the LED driver chip. The "reg" property in the LED specific nodes
> @@ -25,8 +30,12 @@ entry shall contain the string "led@" followed by the number of the LED,
> followed by the referred object name. That object shall be named "LED" followed
> by the number of the LED.
>
> -An ASL example of a camera sensor device and a LED driver device for two LEDs.
> -Objects not relevant for LEDs or the references to them have been omitted.
> +Example
> +=======
> +
> +An ASL example of a camera sensor device and a LED driver device for two LEDs is
> +show below. Objects not relevant for LEDs or the references to them have been
> +omitted. ::
>
> Device (LED)
> {
> @@ -71,12 +80,15 @@ Objects not relevant for LEDs or the references to them have been omitted.
> }
>
> where
> +::
>
> LED LED driver device
> LED0 First LED
> LED1 Second LED
> - SEN Camera sensor device (or another device the LED is
> - related to)
> + SEN Camera sensor device (or another device the LED is related to)
> +
> +References
> +==========
>
> [1] Device tree. <URL:http://www.devicetree.org>, referenced 2019-02-21.
>
> diff --git a/Documentation/firmware-guide/acpi/index.rst b/Documentation/firmware-guide/acpi/index.rst
> index 90c90d42d9ad..ad3b5afdae77 100644
> --- a/Documentation/firmware-guide/acpi/index.rst
> +++ b/Documentation/firmware-guide/acpi/index.rst
> @@ -10,6 +10,7 @@ ACPI Support
> namespace
> dsd/graph
> dsd/data-node-references
> + dsd/leds
> enumeration
> osi
> method-customizing
>
Applied, thanks!
