linux/Documentation/leds/index.rst

.. SPDX-License-Identifier: GPL-2.0

====
LEDs
====

.. toctree::
   :maxdepth: 1

   leds-class
   leds-class-flash
   leds-class-multicolor
   ledtrig-oneshot
   ledtrig-transient
   ledtrig-usbport

   uleds

   leds-blinkm
   leds-el15203000
   leds-lm3556
   leds-lp3944
   leds-lp5521
   leds-lp5523
   leds-lp5562
   leds-lp55xx
   leds-mlxcpld
   leds-sc27xx
   leds-qcom-lpg
docs: leds: add it to the driver-api book The contents of leds driver docs is messy: it has lots of admin-guide stuff and kernel internal ones, just like other driver subsystems. I'm opting to keep the dir at the same place and just add a link to it. This makes clearer that this require changes. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> 2019-06-18 19:51:34 +00:00			`.. SPDX-License-Identifier: GPL-2.0`
docs: leds: convert to ReST Rename the leds documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Pavel Machek <pavel@ucw.cz> Signed-off-by: Jacek Anaszewski <jacek.anaszewski@gmail.com> 2019-06-28 12:20:20 +00:00
			`====`
			`LEDs`
			`====`

			`.. toctree::`
			`:maxdepth: 1`

			`leds-class`
			`leds-class-flash`
leds: multicolor: Introduce a multicolor class definition Introduce a multicolor class that groups colored LEDs within a LED node. The multicolor class groups monochrome LEDs and allows controlling two aspects of the final combined color: hue and lightness. The former is controlled via the intensity file and the latter is controlled via brightness file. Signed-off-by: Dan Murphy <dmurphy@ti.com> Acked-by: Jacek Anaszewski <jacek.anaszewski@gmail.com> Signed-off-by: Pavel Machek <pavel@ucw.cz> [squashed leds: multicolor: Fix camel case in documentation in] 2020-07-16 18:19:56 +00:00			`leds-class-multicolor`
docs: leds: convert to ReST Rename the leds documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Pavel Machek <pavel@ucw.cz> Signed-off-by: Jacek Anaszewski <jacek.anaszewski@gmail.com> 2019-06-28 12:20:20 +00:00			`ledtrig-oneshot`
			`ledtrig-transient`
			`ledtrig-usbport`

			`uleds`

			`leds-blinkm`
docs: ABI: sysfs-class-led-trigger-pattern: remove hw_pattern duplication The ABI files are supposed to be unique. Yet, in the specific case of hw_pattern, there are some duplicated entries as warned by scripts/get_abi.pl: Warning: /sys/class/leds/<led>/hw_pattern is defined 3 times: Documentation/ABI/testing/sysfs-class-led-trigger-pattern:14 Documentation/ABI/testing/sysfs-class-led-driver-sc27xx:0 Documentation/ABI/testing/sysfs-class-led-driver-el15203000:0 Drop the duplication from the ABI files, moving the specific definitions to files inside Documentation/leds. Acked-by: Jonathan Corbet <corbet@lwn.net> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/038e57881550550b298e598f8f9b7f20515cbe15.1604042072.git.mchehab+huawei@kernel.org Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> 2020-10-30 07:40:57 +00:00			`leds-el15203000`
docs: leds: convert to ReST Rename the leds documentation files to ReST, add an index for them and adjust in order to produce a nice html output via the Sphinx build system. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Pavel Machek <pavel@ucw.cz> Signed-off-by: Jacek Anaszewski <jacek.anaszewski@gmail.com> 2019-06-28 12:20:20 +00:00			`leds-lm3556`
			`leds-lp3944`
			`leds-lp5521`
			`leds-lp5523`
			`leds-lp5562`
			`leds-lp55xx`
			`leds-mlxcpld`
docs: leds: index.rst: add a missing file Changeset 26a07553041e ("docs: ABI: sysfs-class-led-trigger-pattern: remove hw_pattern duplication") didn't include the needed changes at index.rst. Fixes: 26a07553041e ("docs: ABI: sysfs-class-led-trigger-pattern: remove hw_pattern duplication") Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/36a6e3aef6e57ea349f1b47c7731d4cd1e03ca77.1604312590.git.mchehab+huawei@kernel.org Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> 2020-11-02 10:32:14 +00:00			`leds-sc27xx`
docs: leds: fix the following docu build warning Add leds-qcom-lpg to Documentation/leds/index.rst to fix the following doc build warning. Documentation/leds/leds-qcom-lpg.rst: WARNING: document isn't included in any toctree Signed-off-by: Shuah Khan <skhan@linuxfoundation.org> Link: https://lore.kernel.org/r/20230125154426.12464-1-skhan@linuxfoundation.org Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2023-01-25 15:44:26 +00:00			`leds-qcom-lpg`