From 9e1cbede267916e737c4a755059418da3ac4de95 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Thu, 13 Jun 2019 15:07:43 -0300 Subject: [PATCH] docs: admin-guide: add laptops documentation The docs under Documentation/laptops contain users specific information. Signed-off-by: Mauro Carvalho Chehab Acked-by: Andy Shevchenko --- Documentation/ABI/testing/sysfs-block-device | 2 +- Documentation/ABI/testing/sysfs-platform-asus-laptop | 2 +- Documentation/admin-guide/index.rst | 1 + Documentation/admin-guide/kernel-parameters.txt | 2 +- Documentation/{ => admin-guide}/laptops/asus-laptop.rst | 0 .../{ => admin-guide}/laptops/disk-shock-protection.rst | 0 Documentation/{ => admin-guide}/laptops/index.rst | 1 - Documentation/{ => admin-guide}/laptops/laptop-mode.rst | 0 Documentation/{ => admin-guide}/laptops/lg-laptop.rst | 1 - Documentation/{ => admin-guide}/laptops/sony-laptop.rst | 0 Documentation/{ => admin-guide}/laptops/sonypi.rst | 0 Documentation/{ => admin-guide}/laptops/thinkpad-acpi.rst | 0 Documentation/{ => admin-guide}/laptops/toshiba_haps.rst | 0 Documentation/admin-guide/sysctl/vm.rst | 4 ++-- MAINTAINERS | 4 ++-- drivers/char/Kconfig | 2 +- drivers/platform/x86/Kconfig | 4 ++-- 17 files changed, 11 insertions(+), 12 deletions(-) rename Documentation/{ => admin-guide}/laptops/asus-laptop.rst (100%) rename Documentation/{ => admin-guide}/laptops/disk-shock-protection.rst (100%) rename Documentation/{ => admin-guide}/laptops/index.rst (95%) rename Documentation/{ => admin-guide}/laptops/laptop-mode.rst (100%) rename Documentation/{ => admin-guide}/laptops/lg-laptop.rst (99%) rename Documentation/{ => admin-guide}/laptops/sony-laptop.rst (100%) rename Documentation/{ => admin-guide}/laptops/sonypi.rst (100%) rename Documentation/{ => admin-guide}/laptops/thinkpad-acpi.rst (100%) rename Documentation/{ => admin-guide}/laptops/toshiba_haps.rst (100%) diff --git a/Documentation/ABI/testing/sysfs-block-device b/Documentation/ABI/testing/sysfs-block-device index 0d57bbb4fddc..17f2bc7dd261 100644 --- a/Documentation/ABI/testing/sysfs-block-device +++ b/Documentation/ABI/testing/sysfs-block-device @@ -45,7 +45,7 @@ Description: - Values below -2 are rejected with -EINVAL For more information, see - Documentation/laptops/disk-shock-protection.rst + Documentation/admin-guide/laptops/disk-shock-protection.rst What: /sys/block/*/device/ncq_prio_enable diff --git a/Documentation/ABI/testing/sysfs-platform-asus-laptop b/Documentation/ABI/testing/sysfs-platform-asus-laptop index d67fa4bafa70..8b0e8205a6a2 100644 --- a/Documentation/ABI/testing/sysfs-platform-asus-laptop +++ b/Documentation/ABI/testing/sysfs-platform-asus-laptop @@ -31,7 +31,7 @@ Description: To control the LED display, use the following : echo 0x0T000DDD > /sys/devices/platform/asus_laptop/ where T control the 3 letters display, and DDD the 3 digits display. - The DDD table can be found in Documentation/laptops/asus-laptop.rst + The DDD table can be found in Documentation/admin-guide/laptops/asus-laptop.rst What: /sys/devices/platform/asus_laptop/bluetooth Date: January 2007 diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst index 5c6ae1ccee1a..6fcc83aaa9b6 100644 --- a/Documentation/admin-guide/index.rst +++ b/Documentation/admin-guide/index.rst @@ -82,6 +82,7 @@ configure specific aspects of kernel behavior to your liking. perf-security acpi/index device-mapper/index + laptops/index .. only:: subproject and html diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt index b323f5d4366a..4821175a3769 100644 --- a/Documentation/admin-guide/kernel-parameters.txt +++ b/Documentation/admin-guide/kernel-parameters.txt @@ -4347,7 +4347,7 @@ Format: sonypi.*= [HW] Sony Programmable I/O Control Device driver - See Documentation/laptops/sonypi.rst + See Documentation/admin-guide/laptops/sonypi.rst spectre_v2= [X86] Control mitigation of Spectre variant 2 (indirect branch speculation) vulnerability. diff --git a/Documentation/laptops/asus-laptop.rst b/Documentation/admin-guide/laptops/asus-laptop.rst similarity index 100% rename from Documentation/laptops/asus-laptop.rst rename to Documentation/admin-guide/laptops/asus-laptop.rst diff --git a/Documentation/laptops/disk-shock-protection.rst b/Documentation/admin-guide/laptops/disk-shock-protection.rst similarity index 100% rename from Documentation/laptops/disk-shock-protection.rst rename to Documentation/admin-guide/laptops/disk-shock-protection.rst diff --git a/Documentation/laptops/index.rst b/Documentation/admin-guide/laptops/index.rst similarity index 95% rename from Documentation/laptops/index.rst rename to Documentation/admin-guide/laptops/index.rst index 001a30910d09..6b554e39863b 100644 --- a/Documentation/laptops/index.rst +++ b/Documentation/admin-guide/laptops/index.rst @@ -1,4 +1,3 @@ -:orphan: ============== Laptop Drivers diff --git a/Documentation/laptops/laptop-mode.rst b/Documentation/admin-guide/laptops/laptop-mode.rst similarity index 100% rename from Documentation/laptops/laptop-mode.rst rename to Documentation/admin-guide/laptops/laptop-mode.rst diff --git a/Documentation/laptops/lg-laptop.rst b/Documentation/admin-guide/laptops/lg-laptop.rst similarity index 99% rename from Documentation/laptops/lg-laptop.rst rename to Documentation/admin-guide/laptops/lg-laptop.rst index f2c2ffe31101..ce9b14671cb9 100644 --- a/Documentation/laptops/lg-laptop.rst +++ b/Documentation/admin-guide/laptops/lg-laptop.rst @@ -1,6 +1,5 @@ .. SPDX-License-Identifier: GPL-2.0+ -:orphan: LG Gram laptop extra features ============================= diff --git a/Documentation/laptops/sony-laptop.rst b/Documentation/admin-guide/laptops/sony-laptop.rst similarity index 100% rename from Documentation/laptops/sony-laptop.rst rename to Documentation/admin-guide/laptops/sony-laptop.rst diff --git a/Documentation/laptops/sonypi.rst b/Documentation/admin-guide/laptops/sonypi.rst similarity index 100% rename from Documentation/laptops/sonypi.rst rename to Documentation/admin-guide/laptops/sonypi.rst diff --git a/Documentation/laptops/thinkpad-acpi.rst b/Documentation/admin-guide/laptops/thinkpad-acpi.rst similarity index 100% rename from Documentation/laptops/thinkpad-acpi.rst rename to Documentation/admin-guide/laptops/thinkpad-acpi.rst diff --git a/Documentation/laptops/toshiba_haps.rst b/Documentation/admin-guide/laptops/toshiba_haps.rst similarity index 100% rename from Documentation/laptops/toshiba_haps.rst rename to Documentation/admin-guide/laptops/toshiba_haps.rst diff --git a/Documentation/admin-guide/sysctl/vm.rst b/Documentation/admin-guide/sysctl/vm.rst index 5aceb5cd5ce7..64aeee1009ca 100644 --- a/Documentation/admin-guide/sysctl/vm.rst +++ b/Documentation/admin-guide/sysctl/vm.rst @@ -108,7 +108,7 @@ block_dump ========== block_dump enables block I/O debugging when set to a nonzero value. More -information on block I/O debugging is in Documentation/laptops/laptop-mode.rst. +information on block I/O debugging is in Documentation/admin-guide/laptops/laptop-mode.rst. compact_memory @@ -298,7 +298,7 @@ laptop_mode =========== laptop_mode is a knob that controls "laptop mode". All the things that are -controlled by this knob are discussed in Documentation/laptops/laptop-mode.rst. +controlled by this knob are discussed in Documentation/admin-guide/laptops/laptop-mode.rst. legacy_va_layout diff --git a/MAINTAINERS b/MAINTAINERS index b0e044be81ac..288f84dbd480 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -9029,7 +9029,7 @@ M: Matan Ziv-Av L: platform-driver-x86@vger.kernel.org S: Maintained F: Documentation/ABI/testing/sysfs-platform-lg-laptop -F: Documentation/laptops/lg-laptop.rst +F: Documentation/admin-guide/laptops/lg-laptop.rst F: drivers/platform/x86/lg-laptop.c LG2160 MEDIA DRIVER @@ -14888,7 +14888,7 @@ M: Mattia Dongili L: platform-driver-x86@vger.kernel.org W: http://www.linux.it/~malattia/wiki/index.php/Sony_drivers S: Maintained -F: Documentation/laptops/sony-laptop.rst +F: Documentation/admin-guide/laptops/sony-laptop.rst F: drivers/char/sonypi.c F: drivers/platform/x86/sony-laptop.c F: include/linux/sony-laptop.h diff --git a/drivers/char/Kconfig b/drivers/char/Kconfig index bb734066075f..442403abd73a 100644 --- a/drivers/char/Kconfig +++ b/drivers/char/Kconfig @@ -382,7 +382,7 @@ config SONYPI Device which can be found in many (all ?) Sony Vaio laptops. If you have one of those laptops, read - , and say Y or M here. + , and say Y or M here. To compile this driver as a module, choose M here: the module will be called sonypi. diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig index 8f91d9ef8a7b..5f580580a8e0 100644 --- a/drivers/platform/x86/Kconfig +++ b/drivers/platform/x86/Kconfig @@ -448,7 +448,7 @@ config SONY_LAPTOP screen brightness control, Fn keys and allows powering on/off some devices. - Read for more information. + Read for more information. config SONYPI_COMPAT bool "Sonypi compatibility" @@ -500,7 +500,7 @@ config THINKPAD_ACPI support for Fn-Fx key combinations, Bluetooth control, video output switching, ThinkLight control, UltraBay eject and more. For more information about this driver see - and + and . This driver was formerly known as ibm-acpi. -- 2.20.1