From 84097cbd3495d7ea966cbd1f2f5385a872576033 Mon Sep 17 00:00:00 2001 From: Henrique de Moraes Holschuh Date: Wed, 21 Nov 2007 18:41:45 -0200 Subject: [PATCH] ACPI: thinkpad-acpi: document keymap gotcha's Publish the requirements for keymap changes. This is a documentation change, only. Currently, people look at the thinkpad-acpi default keymaps, and think: "modifying this is a trivial thing, it can't break systems, and there are keys defined for foo and bar, but the driver has them as KEY_RESERVED. Must have been an oversight, let me change it." And since they never get to see the bug reports, because they are not really a part of the Linux ThinkPad users community (linux-thinkpad mailinglist, thinkwiki wiki, thinkpad forums) and laptop users are slow to complain to distros about any breakages... Signed-off-by: Henrique de Moraes Holschuh --- drivers/misc/thinkpad_acpi.c | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/drivers/misc/thinkpad_acpi.c b/drivers/misc/thinkpad_acpi.c index cf56647a6ca..8ebe2dc6006 100644 --- a/drivers/misc/thinkpad_acpi.c +++ b/drivers/misc/thinkpad_acpi.c @@ -955,6 +955,30 @@ static struct attribute *hotkey_mask_attributes[] __initdata = { static int __init hotkey_init(struct ibm_init_struct *iibm) { + /* Requirements for changing the default keymaps: + * + * 1. Many of the keys are mapped to KEY_RESERVED for very + * good reasons. Do not change them unless you have deep + * knowledge on the IBM and Lenovo ThinkPad firmware for + * the various ThinkPad models; + * + * 2. You must be subscribed to the linux-thinkpad and + * ibm-acpi-devel mailing lists, and you should read the + * list archives since 2007. This requirement exists so + * that you know the past history of problems with the + * thinkpad-acpi driver keymaps, and also that you will + * be listening to any bug reports; + * + * 3. Do not send thinkpad-acpi specific patches directly to + * Linus or to Andrew for merging. Send them to the + * linux-acpi mailinglist, for comments. Merging is to + * be done through acpi-test and the ACPI maintainer. + * + * If the above is too much to ask, please consider sending a + * simple email to the thinkpad-acpi maintainer describing the + * changes you wanted to make and the rationale behind them, + * instead. + */ static u16 ibm_keycode_map[] __initdata = { /* Scan Codes 0x00 to 0x0B: ACPI HKEY FN+F1..F12 */ KEY_FN_F1, KEY_FN_F2, KEY_COFFEE, KEY_SLEEP, -- 2.11.4.GIT