Re: [RFC PATCH 1/8] docs: Add block device LED trigger documentation
From: Greg KH <gregkh@linuxfoundation.org>
Date: 2021-07-29 05:53:26
Also in:
kernelnewbies, linux-leds, lkml
On Wed, Jul 28, 2021 at 08:53:37PM -0500, Ian Pilcher wrote:
* Document the sysfs attributes (/sys/class/block/led_trigger_*
and /sys/class/block/${DEV}/led_trigger) that can be used to
create, list, and delete block device LED triggers and to
set and clear device/trigger associations.sysfs apis belong in Documentation/ABI/ like all other entries.
quoted hunk ↗ jump to hunk
* Pull API documentation from block/blk-ledtrig.c (once it exists). Signed-off-by: Ian Pilcher <redacted> --- Documentation/block/index.rst | 1 + Documentation/block/led-triggers.rst | 124 +++++++++++++++++++++++++++ 2 files changed, 125 insertions(+) create mode 100644 Documentation/block/led-triggers.rstdiff --git a/Documentation/block/index.rst b/Documentation/block/index.rst index 86dcf7159f99..a125ecdb4c7b 100644 --- a/Documentation/block/index.rst +++ b/Documentation/block/index.rst@@ -25,3 +25,4 @@ Block stat switching-sched writeback_cache_control + led-triggersdiff --git a/Documentation/block/led-triggers.rst b/Documentation/block/led-triggers.rst new file mode 100644 index 000000000000..a67e06c68073 --- /dev/null +++ b/Documentation/block/led-triggers.rst@@ -0,0 +1,124 @@ +.. SPDX-License-Identifier: GPL-2.0 + +============ +LED Triggers +============ + +Available when ``CONFIG_BLK_LED_TRIGGERS=y``. + +sysfs interface +=============== + +Create a new block device LED trigger:: + + # echo foo > /sys/class/block/led_trigger_new + +The name must be unique among all LED triggers (not just block device LED +triggers). + +Create two more:: + + # echo bar baz > /sys/class/block/led_trigger_new + +List the triggers:: + + # cat /sys/class/block/led_trigger_list + baz: 0 + bar: 0 + foo: 0
As was pointed out, this is not ok for a sysfs file, sorry. thanks, greg k-h