linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Orlando Chamberlain <orlandoch.dev@gmail.com>
To: linux-doc@vger.kernel.org, linux-input@vger.kernel.org
Cc: "Jonathan Corbet" <corbet@lwn.net>,
	"Jiri Kosina" <jikos@kernel.org>,
	"Benjamin Tissoires" <benjamin.tissoires@redhat.com>,
	linux-kernel@vger.kernel.org, "Pavel Machek" <pavel@ucw.cz>,
	"Aditya Garg" <gargaditya08@live.com>,
	"Aun-Ali Zaidi" <admin@kodeit.net>,
	"Kerem Karabay" <kekrby@gmail.com>,
	"Andy Shevchenko" <andy@infradead.org>,
	"Thomas Weißschuh" <thomas@t-8ch.de>,
	"Orlando Chamberlain" <orlandoch.dev@gmail.com>
Subject: [PATCH v4 1/2] Documentation: leds: standardise keyboard backlight led names
Date: Sat, 18 Feb 2023 20:07:08 +1100	[thread overview]
Message-ID: <20230218090709.7467-2-orlandoch.dev@gmail.com> (raw)
In-Reply-To: <20230218090709.7467-1-orlandoch.dev@gmail.com>

Advice use of either "input*:*:kbd_backlight" or ":*:kbd_backlight". We
don't want people using vendor or product name (e.g. "smc", "apple",
"asus") as this information is available from sysfs anyway, and it made the
folder names inconsistent.

Signed-off-by: Orlando Chamberlain <orlandoch.dev@gmail.com>
---
 Documentation/leds/well-known-leds.txt | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/Documentation/leds/well-known-leds.txt b/Documentation/leds/well-known-leds.txt
index 2160382c86be..4e5429fce4d8 100644
--- a/Documentation/leds/well-known-leds.txt
+++ b/Documentation/leds/well-known-leds.txt
@@ -44,6 +44,14 @@ Legacy: "lp5523:kb{1,2,3,4,5,6}" (Nokia N900)
 
 Frontlight/backlight of main keyboard.
 
+Good: ":*:kbd_backlight"
+Good: "input*:*:kbd_backlight"
+Legacy: "*:*:kbd_backlight"
+
+Many drivers have the vendor or product name as the first field of the led name,
+this makes names inconsistent and is redundant as that information is already in
+sysfs.
+
 Legacy: "button-backlight" (Motorola Droid 4)
 
 Some phones have touch buttons below screen; it is different from main
-- 
2.39.1


  reply	other threads:[~2023-02-18  9:08 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-02-18  9:07 [PATCH v4 0/2] Apple Magic Keyboard Backlight Orlando Chamberlain
2023-02-18  9:07 ` Orlando Chamberlain [this message]
2023-02-18  9:07 ` [PATCH v4 2/2] HID: hid-apple-magic-backlight: Add driver for keyboard backlight on internal Magic Keyboards Orlando Chamberlain
2023-02-19 14:09   ` Andy Shevchenko
2023-02-20  7:09     ` Orlando Chamberlain
2023-02-20 11:29       ` Andy Shevchenko
2023-02-20 11:45         ` Orlando Chamberlain
2023-02-20  8:33   ` Aditya Garg
2023-02-20 11:45     ` Orlando Chamberlain

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230218090709.7467-2-orlandoch.dev@gmail.com \
    --to=orlandoch.dev@gmail.com \
    --cc=admin@kodeit.net \
    --cc=andy@infradead.org \
    --cc=benjamin.tissoires@redhat.com \
    --cc=corbet@lwn.net \
    --cc=gargaditya08@live.com \
    --cc=jikos@kernel.org \
    --cc=kekrby@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-input@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=pavel@ucw.cz \
    --cc=thomas@t-8ch.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).