Don't let ReST documents orphaned
Subsystems (120)
PATCH 1/39 docs: thermal: add it to the driver API
In reply to Mauro Carvalho ChehabThe file contents mostly describes driver internals.
---
Documentation/driver-api/index.rst | 1 +
.../{ => driver-api}/thermal/cpu-cooling-api.rst | 0
.../{ => driver-api}/thermal/exynos_thermal.rst | 0
.../thermal/exynos_thermal_emulation.rst | 0
Documentation/{ => driver-api}/thermal/index.rst | 2 --
.../{ => driver-api}/thermal/intel_powerclamp.rst | 0
.../{ => driver-api}/thermal/nouveau_thermal.rst | 0
.../{ => driver-api}/thermal/power_allocator.rst | 0
Documentation/{ => driver-api}/thermal/sysfs-api.rst | 12 ++++++------
.../thermal/x86_pkg_temperature_thermal.rst | 2 +-
MAINTAINERS | 2 +-
include/linux/thermal.h | 4 ++--
12 files changed, 11 insertions(+), 12 deletions(-)
rename Documentation/{ => driver-api}/thermal/cpu-cooling-api.rst (100%)
rename Documentation/{ => driver-api}/thermal/exynos_thermal.rst (100%)
rename Documentation/{ => driver-api}/thermal/exynos_thermal_emulation.rst (100%)
rename Documentation/{ => driver-api}/thermal/index.rst (95%)
rename Documentation/{ => driver-api}/thermal/intel_powerclamp.rst (100%)
rename Documentation/{ => driver-api}/thermal/nouveau_thermal.rst (100%)
rename Documentation/{ => driver-api}/thermal/power_allocator.rst (100%)
rename Documentation/{ => driver-api}/thermal/sysfs-api.rst (98%)
rename Documentation/{ => driver-api}/thermal/x86_pkg_temperature_thermal.rst (94%)Documentation/driver-api/index.rst +1 -0
@@ -56,6 +56,7 @@ available subsections can be seen below. dmaengine/index slimbus soundwire/index + thermal/index fpga/index acpi/index generic-counter
Documentation/driver-api/thermal/cpu-cooling-api.rst renamed from Documentation/thermal/cpu-cooling-api.rst +0 -0
Documentation/driver-api/thermal/exynos_thermal.rst renamed from Documentation/thermal/exynos_thermal.rst +0 -0
Documentation/driver-api/thermal/exynos_thermal_emulation.rst renamed from Documentation/thermal/exynos_thermal_emulation.rst +0 -0
Documentation/driver-api/thermal/index.rst renamed from Documentation/thermal/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ======= Thermal =======
Documentation/driver-api/thermal/intel_powerclamp.rst renamed from Documentation/thermal/intel_powerclamp.rst +0 -0
Documentation/driver-api/thermal/nouveau_thermal.rst renamed from Documentation/thermal/nouveau_thermal.rst +0 -0
Documentation/driver-api/thermal/power_allocator.rst renamed from Documentation/thermal/power_allocator.rst +0 -0
Documentation/driver-api/thermal/sysfs-api.rst renamed from Documentation/thermal/sysfs-api.rst +6 -6
@@ -552,7 +552,7 @@ emul_temp sustainable_power An estimate of the sustained power that can be dissipated by the thermal zone. Used by the power allocator governor. For - more information see Documentation/thermal/power_allocator.rst + more information see Documentation/driver-api/thermal/power_allocator.rst Unit: milliwatts
@@ -563,7 +563,7 @@ k_po controller during temperature overshoot. Temperature overshoot is when the current temperature is above the "desired temperature" trip point. For more information see - Documentation/thermal/power_allocator.rst + Documentation/driver-api/thermal/power_allocator.rst RW, Optional
@@ -572,7 +572,7 @@ k_pu controller during temperature undershoot. Temperature undershoot is when the current temperature is below the "desired temperature" trip point. For more information see - Documentation/thermal/power_allocator.rst + Documentation/driver-api/thermal/power_allocator.rst RW, Optional
@@ -580,14 +580,14 @@ k_i The integral term of the power allocator governor's PID controller. This term allows the PID controller to compensate for long term drift. For more information see - Documentation/thermal/power_allocator.rst + Documentation/driver-api/thermal/power_allocator.rst RW, Optional k_d The derivative term of the power allocator governor's PID controller. For more information see - Documentation/thermal/power_allocator.rst + Documentation/driver-api/thermal/power_allocator.rst RW, Optional
@@ -598,7 +598,7 @@ integral_cutoff example, if integral_cutoff is 0, then the integral term only accumulates error when temperature is above the desired temperature trip point. For more information see - Documentation/thermal/power_allocator.rst + Documentation/driver-api/thermal/power_allocator.rst Unit: millidegree Celsius
Documentation/driver-api/thermal/x86_pkg_temperature_thermal.rst renamed from Documentation/thermal/x86_pkg_temperature_thermal.rst +1 -1
@@ -40,7 +40,7 @@ This contains two trip points: - trip_point_1_temp User can set any temperature between 0 to TJ-Max temperature. Temperature units -are in milli-degree Celsius. Refer to "Documentation/thermal/sysfs-api.rst" for +are in milli-degree Celsius. Refer to "Documentation/driver-api/thermal/sysfs-api.rst" for thermal sys-fs details. Any value other than 0 in these trip points, can trigger thermal notifications.
MAINTAINERS +1 -1
@@ -15762,7 +15762,7 @@ M: Viresh Kumar <[email protected]> M: Javi Merino <[email protected]> L: [email protected] S: Supported -F: Documentation/thermal/cpu-cooling-api.rst +F: Documentation/driver-api/thermal/cpu-cooling-api.rst F: drivers/thermal/cpu_cooling.c F: include/linux/cpu_cooling.h
include/linux/thermal.h +2 -2
@@ -251,7 +251,7 @@ struct thermal_bind_params {* platform characterization. This value is relative to the * rest of the weights so a cooling device whose weight is * double that of another cooling device is twice as -* effective. See Documentation/thermal/sysfs-api.rst for more +* effective. See Documentation/driver-api/thermal/sysfs-api.rst for more * information. */ int weight;
@@ -259,7 +259,7 @@ struct thermal_bind_params {/* * This is a bit mask that gives the binding relation between this * thermal zone and cdev, for a particular trip point. -* See Documentation/thermal/sysfs-api.rst for more information. +* See Documentation/driver-api/thermal/sysfs-api.rst for more information. */ int trip_mask;
Signature · 1 line
2.21.0
PATCH 14/39 docs: device-mapper: move it to the admin-guide
In reply to Mauro Carvalho ChehabThe DM support describes lots of aspects related to mapped disk partitions from the userspace PoV.
---
.../{ => admin-guide}/device-mapper/cache-policies.rst | 0
Documentation/{ => admin-guide}/device-mapper/cache.rst | 0
Documentation/{ => admin-guide}/device-mapper/delay.rst | 0
Documentation/{ => admin-guide}/device-mapper/dm-crypt.rst | 0
Documentation/{ => admin-guide}/device-mapper/dm-dust.txt | 0
Documentation/{ => admin-guide}/device-mapper/dm-flakey.rst | 0
Documentation/{ => admin-guide}/device-mapper/dm-init.rst | 0
Documentation/{ => admin-guide}/device-mapper/dm-integrity.rst | 0
Documentation/{ => admin-guide}/device-mapper/dm-io.rst | 0
Documentation/{ => admin-guide}/device-mapper/dm-log.rst | 0
.../{ => admin-guide}/device-mapper/dm-queue-length.rst | 0
Documentation/{ => admin-guide}/device-mapper/dm-raid.rst | 0
.../{ => admin-guide}/device-mapper/dm-service-time.rst | 0
Documentation/{ => admin-guide}/device-mapper/dm-uevent.rst | 0
Documentation/{ => admin-guide}/device-mapper/dm-zoned.rst | 0
Documentation/{ => admin-guide}/device-mapper/era.rst | 0
Documentation/{ => admin-guide}/device-mapper/index.rst | 2 --
Documentation/{ => admin-guide}/device-mapper/kcopyd.rst | 0
Documentation/{ => admin-guide}/device-mapper/linear.rst | 0
Documentation/{ => admin-guide}/device-mapper/log-writes.rst | 0
.../{ => admin-guide}/device-mapper/persistent-data.rst | 0
Documentation/{ => admin-guide}/device-mapper/snapshot.rst | 0
Documentation/{ => admin-guide}/device-mapper/statistics.rst | 0
Documentation/{ => admin-guide}/device-mapper/striped.rst | 0
Documentation/{ => admin-guide}/device-mapper/switch.rst | 0
.../{ => admin-guide}/device-mapper/thin-provisioning.rst | 0
Documentation/{ => admin-guide}/device-mapper/unstriped.rst | 0
Documentation/{ => admin-guide}/device-mapper/verity.rst | 0
Documentation/{ => admin-guide}/device-mapper/writecache.rst | 0
Documentation/{ => admin-guide}/device-mapper/zero.rst | 0
Documentation/admin-guide/index.rst | 1 +
MAINTAINERS | 2 +-
drivers/md/Kconfig | 2 +-
drivers/md/dm-init.c | 2 +-
drivers/md/dm-raid.c | 2 +-
35 files changed, 5 insertions(+), 6 deletions(-)
rename Documentation/{ => admin-guide}/device-mapper/cache-policies.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/cache.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/delay.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-crypt.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-dust.txt (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-flakey.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-init.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-integrity.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-io.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-log.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-queue-length.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-raid.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-service-time.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-uevent.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-zoned.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/era.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/index.rst (98%)
rename Documentation/{ => admin-guide}/device-mapper/kcopyd.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/linear.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/log-writes.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/persistent-data.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/snapshot.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/statistics.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/striped.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/switch.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/thin-provisioning.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/unstriped.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/verity.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/writecache.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/zero.rst (100%)Documentation/admin-guide/device-mapper/cache-policies.rst renamed from Documentation/device-mapper/cache-policies.rst +0 -0
Documentation/admin-guide/device-mapper/cache.rst renamed from Documentation/device-mapper/cache.rst +0 -0
Documentation/admin-guide/device-mapper/delay.rst renamed from Documentation/device-mapper/delay.rst +0 -0
Documentation/admin-guide/device-mapper/dm-crypt.rst renamed from Documentation/device-mapper/dm-crypt.rst +0 -0
Documentation/admin-guide/device-mapper/dm-dust.txt renamed from Documentation/device-mapper/dm-dust.txt +0 -0
Documentation/admin-guide/device-mapper/dm-flakey.rst renamed from Documentation/device-mapper/dm-flakey.rst +0 -0
Documentation/admin-guide/device-mapper/dm-init.rst renamed from Documentation/device-mapper/dm-init.rst +0 -0
Documentation/admin-guide/device-mapper/dm-integrity.rst renamed from Documentation/device-mapper/dm-integrity.rst +0 -0
Documentation/admin-guide/device-mapper/dm-io.rst renamed from Documentation/device-mapper/dm-io.rst +0 -0
Documentation/admin-guide/device-mapper/dm-log.rst renamed from Documentation/device-mapper/dm-log.rst +0 -0
Documentation/admin-guide/device-mapper/dm-queue-length.rst renamed from Documentation/device-mapper/dm-queue-length.rst +0 -0
Documentation/admin-guide/device-mapper/dm-raid.rst renamed from Documentation/device-mapper/dm-raid.rst +0 -0
Documentation/admin-guide/device-mapper/dm-service-time.rst renamed from Documentation/device-mapper/dm-service-time.rst +0 -0
Documentation/admin-guide/device-mapper/dm-uevent.rst renamed from Documentation/device-mapper/dm-uevent.rst +0 -0
Documentation/admin-guide/device-mapper/dm-zoned.rst renamed from Documentation/device-mapper/dm-zoned.rst +0 -0
Documentation/admin-guide/device-mapper/era.rst renamed from Documentation/device-mapper/era.rst +0 -0
Documentation/admin-guide/device-mapper/index.rst renamed from Documentation/device-mapper/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============= Device Mapper =============
Documentation/admin-guide/device-mapper/kcopyd.rst renamed from Documentation/device-mapper/kcopyd.rst +0 -0
Documentation/admin-guide/device-mapper/linear.rst renamed from Documentation/device-mapper/linear.rst +0 -0
Documentation/admin-guide/device-mapper/log-writes.rst renamed from Documentation/device-mapper/log-writes.rst +0 -0
Documentation/admin-guide/device-mapper/persistent-data.rst renamed from Documentation/device-mapper/persistent-data.rst +0 -0
Documentation/admin-guide/device-mapper/snapshot.rst renamed from Documentation/device-mapper/snapshot.rst +0 -0
Documentation/admin-guide/device-mapper/statistics.rst renamed from Documentation/device-mapper/statistics.rst +0 -0
Documentation/admin-guide/device-mapper/striped.rst renamed from Documentation/device-mapper/striped.rst +0 -0
Documentation/admin-guide/device-mapper/switch.rst renamed from Documentation/device-mapper/switch.rst +0 -0
Documentation/admin-guide/device-mapper/thin-provisioning.rst renamed from Documentation/device-mapper/thin-provisioning.rst +0 -0
Documentation/admin-guide/device-mapper/unstriped.rst renamed from Documentation/device-mapper/unstriped.rst +0 -0
Documentation/admin-guide/device-mapper/verity.rst renamed from Documentation/device-mapper/verity.rst +0 -0
Documentation/admin-guide/device-mapper/writecache.rst renamed from Documentation/device-mapper/writecache.rst +0 -0
Documentation/admin-guide/device-mapper/zero.rst renamed from Documentation/device-mapper/zero.rst +0 -0
Documentation/admin-guide/index.rst +1 -0
@@ -79,6 +79,7 @@ configure specific aspects of kernel behavior to your liking. namespaces/index perf-security acpi/index + device-mapper/index .. only:: subproject and html
MAINTAINERS +1 -1
@@ -4703,7 +4703,7 @@ Q: http://patchwork.kernel.org/project/dm-devel/list/ T: git git://git.kernel.org/pub/scm/linux/kernel/git/device-mapper/linux-dm.git T: quilt http://people.redhat.com/agk/patches/linux/editing/ S: Maintained -F: Documentation/device-mapper/ +F: Documentation/admin-guide/device-mapper/ F: drivers/md/Makefile F: drivers/md/Kconfig F: drivers/md/dm*
drivers/md/Kconfig +1 -1
@@ -453,7 +453,7 @@ config DM_INIT Enable "dm-mod.create=" parameter to create mapped devices at init time. This option is useful to allow mounting rootfs without requiring an initramfs. - See Documentation/device-mapper/dm-init.rst for dm-mod.create="..." + See Documentation/admin-guide/device-mapper/dm-init.rst for dm-mod.create="..." format. If unsure, say N.
drivers/md/dm-init.c +1 -1
@@ -25,7 +25,7 @@ static char *create;* Format: dm-mod.create=<name>,<uuid>,<minor>,<flags>,<table>[,<table>+][;<name>,<uuid>,<minor>,<flags>,<table>[,<table>+]+] * Table format: <start_sector> <num_sectors> <target_type> <target_args> * -* See Documentation/device-mapper/dm-init.rst for dm-mod.create="..." format +* See Documentation/admin-guide/device-mapper/dm-init.rst for dm-mod.create="..." format * details. */
drivers/md/dm-raid.c +1 -1
@@ -3558,7 +3558,7 @@ static void raid_status(struct dm_target *ti, status_type_t type,* v1.5.0+: * * Sync action: -* See Documentation/device-mapper/dm-raid.rst for +* See Documentation/admin-guide/device-mapper/dm-raid.rst for * information on each of these states. */ DMEMIT (" %s" , sync_action);
Signature · 1 line
2.21.0
PATCH 17/39 docs: admin-guide: add laptops documentation
In reply to Mauro Carvalho ChehabThe docs under Documentation/laptops contain users specific information.
---
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%)Documentation/ABI/testing/sysfs-block-device +1 -1
@@ -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
Documentation/ABI/testing/sysfs-platform-asus-laptop +1 -1
@@ -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
Documentation/admin-guide/index.rst +1 -0
@@ -81,6 +81,7 @@ configure specific aspects of kernel behavior to your liking. perf-security acpi/index device-mapper/index + laptops/index .. only:: subproject and html
Documentation/admin-guide/kernel-parameters.txt +1 -1
@@ -4373,7 +4373,7 @@ Format: <integer> 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.
Documentation/admin-guide/laptops/asus-laptop.rst renamed from Documentation/laptops/asus-laptop.rst +0 -0
Documentation/admin-guide/laptops/disk-shock-protection.rst renamed from Documentation/laptops/disk-shock-protection.rst +0 -0
Documentation/admin-guide/laptops/index.rst renamed from Documentation/laptops/index.rst +0 -1
@@ -1,4 +1,3 @@ -:orphan: ============== Laptop Drivers
Documentation/admin-guide/laptops/laptop-mode.rst renamed from Documentation/laptops/laptop-mode.rst +0 -0
Documentation/admin-guide/laptops/lg-laptop.rst renamed from Documentation/laptops/lg-laptop.rst +0 -1
@@ -1,6 +1,5 @@ .. SPDX-License-Identifier: GPL-2.0+ -:orphan: LG Gram laptop extra features =============================
Documentation/admin-guide/laptops/sony-laptop.rst renamed from Documentation/laptops/sony-laptop.rst +0 -0
Documentation/admin-guide/laptops/sonypi.rst renamed from Documentation/laptops/sonypi.rst +0 -0
Documentation/admin-guide/laptops/thinkpad-acpi.rst renamed from Documentation/laptops/thinkpad-acpi.rst +0 -0
Documentation/admin-guide/laptops/toshiba_haps.rst renamed from Documentation/laptops/toshiba_haps.rst +0 -0
Documentation/admin-guide/sysctl/vm.rst +2 -2
@@ -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
MAINTAINERS +2 -2
@@ -8978,7 +8978,7 @@ M: Matan Ziv-Av <[email protected]> L: [email protected] 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
@@ -14830,7 +14830,7 @@ M: Mattia Dongili <[email protected]> L: [email protected] 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
drivers/char/Kconfig +1 -1
@@ -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 - <file:Documentation/laptops/sonypi.rst>, and say Y or M here. + <file:Documentation/admin-guide/laptops/sonypi.rst>, and say Y or M here. To compile this driver as a module, choose M here: the module will be called sonypi.
drivers/platform/x86/Kconfig +2 -2
@@ -448,7 +448,7 @@ config SONY_LAPTOP screen brightness control, Fn keys and allows powering on/off some devices. - Read <file:Documentation/laptops/sony-laptop.rst> for more information. + Read <file:Documentation/admin-guide/laptops/sony-laptop.rst> 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 - <file:Documentation/laptops/thinkpad-acpi.rst> and + <file:Documentation/admin-guide/laptops/thinkpad-acpi.rst> and <http://ibm-acpi.sf.net/> . This driver was formerly known as ibm-acpi.
Signature · 1 line
2.21.0
PATCH 18/39 docs: admin-guide: add kdump documentation into it
In reply to Mauro Carvalho ChehabThe Kdump documentation describes procedures with admins use in order to solve issues on their systems.
---
Documentation/admin-guide/bug-hunting.rst | 4 ++--
Documentation/admin-guide/index.rst | 1 +
Documentation/{ => admin-guide}/kdump/gdbmacros.txt | 0
Documentation/{ => admin-guide}/kdump/index.rst | 1 -
Documentation/{ => admin-guide}/kdump/kdump.rst | 0
Documentation/{ => admin-guide}/kdump/vmcoreinfo.rst | 0
Documentation/admin-guide/kernel-parameters.txt | 6 +++---
Documentation/powerpc/firmware-assisted-dump.rst | 2 +-
Documentation/translations/zh_CN/oops-tracing.txt | 4 ++--
Documentation/watchdog/hpwdt.rst | 2 +-
MAINTAINERS | 2 +-
arch/arm/Kconfig | 2 +-
arch/arm64/Kconfig | 2 +-
arch/sh/Kconfig | 2 +-
arch/x86/Kconfig | 4 ++--
15 files changed, 16 insertions(+), 16 deletions(-)
rename Documentation/{ => admin-guide}/kdump/gdbmacros.txt (100%)
rename Documentation/{ => admin-guide}/kdump/index.rst (97%)
rename Documentation/{ => admin-guide}/kdump/kdump.rst (100%)
rename Documentation/{ => admin-guide}/kdump/vmcoreinfo.rst (100%)Documentation/admin-guide/bug-hunting.rst +2 -2
@@ -90,9 +90,9 @@ the disk is not available then you have three options: run a null modem to a second machine and capture the output there using your favourite communication program. Minicom works well. -(3) Use Kdump (see Documentation/kdump/kdump.rst), +(3) Use Kdump (see Documentation/admin-guide/kdump/kdump.rst), extract the kernel ring buffer from old memory with using dmesg - gdbmacro in Documentation/kdump/gdbmacros.txt. + gdbmacro in Documentation/admin-guide/kdump/gdbmacros.txt. Finding the bug's location --------------------------
Documentation/admin-guide/index.rst +1 -0
@@ -39,6 +39,7 @@ problems and bugs in particular. ramoops dynamic-debug-howto init + kdump/index perf/index This is the beginning of a section with information of interest to
Documentation/admin-guide/kdump/gdbmacros.txt renamed from Documentation/kdump/gdbmacros.txt +0 -0
Documentation/admin-guide/kdump/index.rst renamed from Documentation/kdump/index.rst +0 -1
@@ -1,4 +1,3 @@ -:orphan: ================================================================ Documentation for Kdump - The kexec-based Crash Dumping Solution
Documentation/admin-guide/kdump/kdump.rst renamed from Documentation/kdump/kdump.rst +0 -0
Documentation/admin-guide/kdump/vmcoreinfo.rst renamed from Documentation/kdump/vmcoreinfo.rst +0 -0
Documentation/admin-guide/kernel-parameters.txt +3 -3
@@ -708,14 +708,14 @@ [KNL, x86_64] select a region under 4G first, and fall back to reserve region above 4G when '@offset' hasn't been specified. - See Documentation/kdump/kdump.rst for further details. + See Documentation/admin-guide/kdump/kdump.rst for further details. crashkernel=range1:size1[,range2:size2,...][@offset] [KNL] Same as above, but depends on the memory in the running system. The syntax of range is start-[end] where start and end are both a memory unit (amount[KMG]). See also - Documentation/kdump/kdump.rst for an example. + Documentation/admin-guide/kdump/kdump.rst for an example. crashkernel=size[KMG],high [KNL, x86_64] range could be above 4G. Allow kernel
@@ -1207,7 +1207,7 @@ Specifies physical address of start of kernel core image elf header and optionally the size. Generally kexec loader will pass this option to capture kernel. - See Documentation/kdump/kdump.rst for details. + See Documentation/admin-guide/kdump/kdump.rst for details. enable_mtrr_cleanup [X86] The kernel tries to adjust MTRR layout from continuous
Documentation/powerpc/firmware-assisted-dump.rst +1 -1
@@ -61,7 +61,7 @@ as follows: the default calculated size. Use this option if default boot memory size is not sufficient for second kernel to boot successfully. For syntax of crashkernel= parameter, - refer to Documentation/kdump/kdump.rst. If any offset is + refer to Documentation/admin-guide/kdump/kdump.rst. If any offset is provided in crashkernel= parameter, it will be ignored as fadump uses a predefined offset to reserve memory for boot memory dump preservation in case of a crash.
Documentation/translations/zh_CN/oops-tracing.txt +2 -2
@@ -53,8 +53,8 @@ cat /proc/kmsg > file, 然而你必须介入中止传输, kmsg是一个“ (2)用串口终端启动(请参看Documentation/admin-guide/serial-console.rst),运行一个null modem到另一台机器并用你喜欢的通讯工具获取输出。Minicom工作地很好。 -(3)使用Kdump(请参看Documentation/kdump/kdump.rst), -使用在Documentation/kdump/gdbmacros.txt中定义的dmesg gdb宏,从旧的内存中提取内核 +(3)使用Kdump(请参看Documentation/admin-guide/kdump/kdump.rst), +使用在Documentation/admin-guide/kdump/gdbmacros.txt中定义的dmesg gdb宏,从旧的内存中提取内核 环形缓冲区。 完整信息
Documentation/watchdog/hpwdt.rst +1 -1
@@ -59,7 +59,7 @@ Last reviewed: 08/20/2018 and loop forever. This is generally not what a watchdog user wants. For those wishing to learn more please see: - Documentation/kdump/kdump.rst + Documentation/admin-guide/kdump/kdump.rst Documentation/admin-guide/kernel-parameters.txt (panic=) Your Linux Distribution specific documentation.
MAINTAINERS +1 -1
@@ -8622,7 +8622,7 @@ R: Vivek Goyal <[email protected]> L: [email protected] W: http://lse.sourceforge.net/kdump/ S: Maintained -F: Documentation/kdump/ +F: Documentation/admin-guide/kdump/ KEENE FM RADIO TRANSMITTER DRIVER M: Hans Verkuil <[email protected]>
arch/arm/Kconfig +1 -1
@@ -2025,7 +2025,7 @@ config CRASH_DUMP kdump/kexec. The crash dump kernel must be compiled to a memory address not used by the main kernel - For more details see Documentation/kdump/kdump.rst + For more details see Documentation/admin-guide/kdump/kdump.rst config AUTO_ZRELADDR bool "Auto calculation of the decompressed kernel image address"
arch/arm64/Kconfig +1 -1
@@ -997,7 +997,7 @@ config CRASH_DUMP reserved region and then later executed after a crash by kdump/kexec. - For more details see Documentation/kdump/kdump.rst + For more details see Documentation/admin-guide/kdump/kdump.rst config XEN_DOM0 def_bool y
arch/sh/Kconfig +1 -1
@@ -626,7 +626,7 @@ config CRASH_DUMP to a memory address not used by the main kernel using PHYSICAL_START. - For more details see Documentation/kdump/kdump.rst + For more details see Documentation/admin-guide/kdump/kdump.rst config KEXEC_JUMP bool "kexec jump (EXPERIMENTAL)"
arch/x86/Kconfig +2 -2
@@ -2057,7 +2057,7 @@ config CRASH_DUMP to a memory address not used by the main kernel or BIOS using PHYSICAL_START, or it must be built as a relocatable image (CONFIG_RELOCATABLE=y). - For more details see Documentation/kdump/kdump.rst + For more details see Documentation/admin-guide/kdump/kdump.rst config KEXEC_JUMP bool "kexec jump"
@@ -2094,7 +2094,7 @@ config PHYSICAL_START the reserved region. In other words, it can be set based on the "X" value as specified in the "crashkernel=YM@XM" command line boot parameter passed to the panic-ed - kernel. Please take a look at Documentation/kdump/kdump.rst + kernel. Please take a look at Documentation/admin-guide/kdump/kdump.rst for more details about crash dumps. Usage of bzImage for capturing the crash dump is recommended as
Signature · 7 lines
2.21.0 _______________________________________________ kexec mailing list [email protected] http://lists.infradead.org/mailman/listinfo/kexec
PATCH 24/39 docs: driver-model: move it to the driver-api book
In reply to Mauro Carvalho ChehabThe audience for the Kernel driver-model is clearly Kernel hackers.
---
Documentation/{ => driver-api}/driver-model/binding.rst | 0
Documentation/{ => driver-api}/driver-model/bus.rst | 0
Documentation/{ => driver-api}/driver-model/class.rst | 0
.../{ => driver-api}/driver-model/design-patterns.rst | 0
Documentation/{ => driver-api}/driver-model/device.rst | 0
Documentation/{ => driver-api}/driver-model/devres.rst | 0
Documentation/{ => driver-api}/driver-model/driver.rst | 0
Documentation/{ => driver-api}/driver-model/index.rst | 2 --
Documentation/{ => driver-api}/driver-model/overview.rst | 0
Documentation/{ => driver-api}/driver-model/platform.rst | 0
Documentation/{ => driver-api}/driver-model/porting.rst | 2 +-
Documentation/driver-api/gpio/driver.rst | 2 +-
Documentation/driver-api/index.rst | 1 +
Documentation/eisa.txt | 4 ++--
Documentation/filesystems/sysfs.txt | 2 +-
Documentation/hwmon/submitting-patches.rst | 2 +-
Documentation/translations/zh_CN/filesystems/sysfs.txt | 2 +-
drivers/base/platform.c | 2 +-
drivers/gpio/gpio-cs5535.c | 2 +-
drivers/net/ethernet/intel/ice/ice_main.c | 2 +-
drivers/staging/unisys/Documentation/overview.txt | 4 ++--
include/linux/device.h | 2 +-
include/linux/platform_device.h | 2 +-
scripts/coccinelle/free/devm_free.cocci | 2 +-
24 files changed, 16 insertions(+), 17 deletions(-)
rename Documentation/{ => driver-api}/driver-model/binding.rst (100%)
rename Documentation/{ => driver-api}/driver-model/bus.rst (100%)
rename Documentation/{ => driver-api}/driver-model/class.rst (100%)
rename Documentation/{ => driver-api}/driver-model/design-patterns.rst (100%)
rename Documentation/{ => driver-api}/driver-model/device.rst (100%)
rename Documentation/{ => driver-api}/driver-model/devres.rst (100%)
rename Documentation/{ => driver-api}/driver-model/driver.rst (100%)
rename Documentation/{ => driver-api}/driver-model/index.rst (96%)
rename Documentation/{ => driver-api}/driver-model/overview.rst (100%)
rename Documentation/{ => driver-api}/driver-model/platform.rst (100%)
rename Documentation/{ => driver-api}/driver-model/porting.rst (99%)Documentation/driver-api/driver-model/binding.rst renamed from Documentation/driver-model/binding.rst +0 -0
Documentation/driver-api/driver-model/bus.rst renamed from Documentation/driver-model/bus.rst +0 -0
Documentation/driver-api/driver-model/class.rst renamed from Documentation/driver-model/class.rst +0 -0
Documentation/driver-api/driver-model/design-patterns.rst renamed from Documentation/driver-model/design-patterns.rst +0 -0
Documentation/driver-api/driver-model/device.rst renamed from Documentation/driver-model/device.rst +0 -0
Documentation/driver-api/driver-model/devres.rst renamed from Documentation/driver-model/devres.rst +0 -0
Documentation/driver-api/driver-model/driver.rst renamed from Documentation/driver-model/driver.rst +0 -0
Documentation/driver-api/driver-model/index.rst renamed from Documentation/driver-model/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============ Driver Model ============
Documentation/driver-api/driver-model/overview.rst renamed from Documentation/driver-model/overview.rst +0 -0
Documentation/driver-api/driver-model/platform.rst renamed from Documentation/driver-model/platform.rst +0 -0
Documentation/driver-api/driver-model/porting.rst renamed from Documentation/driver-model/porting.rst +1 -1
@@ -9,7 +9,7 @@ Patrick Mochel Overview -Please refer to `Documentation/driver-model/*.rst` for definitions of +Please refer to `Documentation/driver-api/driver-model/*.rst` for definitions of various driver types and concepts. Most of the work of porting devices drivers to the new model happens
Documentation/driver-api/gpio/driver.rst +1 -1
@@ -399,7 +399,7 @@ symbol: will pass the struct gpio_chip* for the chip to all IRQ callbacks, so the callbacks need to embed the gpio_chip in its state container and obtain a pointer to the container using container_of(). - (See Documentation/driver-model/design-patterns.rst) + (See Documentation/driver-api/driver-model/design-patterns.rst) - gpiochip_irqchip_add_nested(): adds a nested cascaded irqchip to a gpiochip, as discussed above regarding different types of cascaded irqchips. The
Documentation/driver-api/index.rst +1 -0
@@ -14,6 +14,7 @@ available subsections can be seen below. .. toctree:: :maxdepth: 2 + driver-model/index basics infrastructure early-userspace/index
Documentation/eisa.txt +2 -2
@@ -103,7 +103,7 @@ id_table an array of NULL terminated EISA id strings, (driver_data). driver a generic driver, such as described in - Documentation/driver-model/driver.rst. Only .name, + Documentation/driver-api/driver-model/driver.rst. Only .name, .probe and .remove members are mandatory. =============== ====================================================
@@ -152,7 +152,7 @@ state set of flags indicating the state of the device. Current flags are EISA_CONFIG_ENABLED and EISA_CONFIG_FORCED. res set of four 256 bytes I/O regions allocated to this device dma_mask DMA mask set from the parent device. -dev generic device (see Documentation/driver-model/device.rst) +dev generic device (see Documentation/driver-api/driver-model/device.rst) ======== ============================================================ You can get the 'struct eisa_device' from 'struct device' using the
Documentation/filesystems/sysfs.txt +1 -1
@@ -319,7 +319,7 @@ quick way to lookup the sysfs interface for a device from the result of a stat(2) operation. More information can driver-model specific features can be found in -Documentation/driver-model/. +Documentation/driver-api/driver-model/. TODO: Finish this section.
Documentation/hwmon/submitting-patches.rst +1 -1
@@ -89,7 +89,7 @@ increase the chances of your change being accepted. console. Excessive logging can seriously affect system performance. * Use devres functions whenever possible to allocate resources. For rationale - and supported functions, please see Documentation/driver-model/devres.rst. + and supported functions, please see Documentation/driver-api/driver-model/devres.rst. If a function is not supported by devres, consider using devm_add_action(). * If the driver has a detect function, make sure it is silent. Debug messages
Documentation/translations/zh_CN/filesystems/sysfs.txt +1 -1
@@ -288,7 +288,7 @@ dev/ ???????? char/ ? block/??????????? ???????/sys/dev ???????? stat(2) ??????? ?? sysfs ???????? -???? driver-model ???????? Documentation/driver-model/ +???? driver-model ???????? Documentation/driver-api/driver-model/ ????
drivers/base/platform.c +1 -1
@@ -5,7 +5,7 @@* Copyright (c) 2002-3 Patrick Mochel * Copyright (c) 2002-3 Open Source Development Labs * -* Please see Documentation/driver-model/platform.rst for more +* Please see Documentation/driver-api/driver-model/platform.rst for more * information. */
drivers/gpio/gpio-cs5535.c +1 -1
@@ -41,7 +41,7 @@ MODULE_PARM_DESC(mask, "GPIO channel mask.");/* * FIXME: convert this singleton driver to use the state container -* design pattern, see Documentation/driver-model/design-patterns.rst +* design pattern, see Documentation/driver-api/driver-model/design-patterns.rst */ static struct cs5535_gpio_chip { struct gpio_chip chip;
drivers/net/ethernet/intel/ice/ice_main.c +1 -1
@@ -2286,7 +2286,7 @@ ice_probe(struct pci_dev *pdev, const struct pci_device_id __always_unused *ent)struct ice_hw *hw;int err; -/* this driver uses devres, see Documentation/driver-model/devres.rst */ +/* this driver uses devres, see Documentation/driver-api/driver-model/devres.rst */ err =pcim_enable_device (pdev);if (err)return err;
drivers/staging/unisys/Documentation/overview.txt +2 -2
@@ -15,7 +15,7 @@ normally be unsharable, specifically: * visorinput - keyboard and mouse These drivers conform to the standard Linux bus/device model described -within Documentation/driver-model/, and utilize a driver named visorbus to +within Documentation/driver-api/driver-model/, and utilize a driver named visorbus to present the virtual busses involved. Drivers in the 'visor*' driver set are commonly referred to as "guest drivers" or "client drivers". All drivers except visorbus expose a device of a specific usable class to the Linux guest
@@ -141,7 +141,7 @@ called automatically by the visorbus driver at appropriate times: ----------------------------------- Because visorbus is a standard Linux bus driver in the model described in -Documentation/driver-model/, the hierarchy of s-Par virtual devices is +Documentation/driver-api/driver-model/, the hierarchy of s-Par virtual devices is published in the sysfs tree beneath /bus/visorbus/, e.g., /sys/bus/visorbus/devices/ might look like:
include/linux/device.h +1 -1
@@ -6,7 +6,7 @@* Copyright (c) 2004-2009 Greg Kroah-Hartman <[email protected]> * Copyright (c) 2008-2009 Novell Inc. * -* See Documentation/driver-model/ for more information. +* See Documentation/driver-api/driver-model/ for more information. */ #ifndef _DEVICE_H_
include/linux/platform_device.h +1 -1
@@ -4,7 +4,7 @@* * Copyright (c) 2001-2003 Patrick Mochel <[email protected]> * -* See Documentation/driver-model/ for more information. +* See Documentation/driver-api/driver-model/ for more information. */ #ifndef _PLATFORM_DEVICE_H_
scripts/coccinelle/free/devm_free.cocci +1 -1
@@ -3,7 +3,7 @@ /// functions. Values allocated using the devm_functions are freed when /// the device is detached, and thus the use of the standard freeing /// function would cause a double free. -/// See Documentation/driver-model/devres.rst for more information. +/// See Documentation/driver-api/driver-model/devres.rst for more information. /// /// A difficulty of detecting this problem is that the standard freeing /// function might be called from a different function than the one
Signature · 1 line
2.21.0
PATCH 27/39 docs: cgroup-v1: add it to the admin-guide book
In reply to Mauro Carvalho ChehabThose files belong to the admin guide, so add them.
---
.../{ => admin-guide}/cgroup-v1/blkio-controller.rst | 0
Documentation/{ => admin-guide}/cgroup-v1/cgroups.rst | 4 ++--
Documentation/{ => admin-guide}/cgroup-v1/cpuacct.rst | 0
Documentation/{ => admin-guide}/cgroup-v1/cpusets.rst | 2 +-
Documentation/{ => admin-guide}/cgroup-v1/devices.rst | 0
.../{ => admin-guide}/cgroup-v1/freezer-subsystem.rst | 0
Documentation/{ => admin-guide}/cgroup-v1/hugetlb.rst | 0
Documentation/{ => admin-guide}/cgroup-v1/index.rst | 2 --
Documentation/{ => admin-guide}/cgroup-v1/memcg_test.rst | 4 ++--
Documentation/{ => admin-guide}/cgroup-v1/memory.rst | 0
Documentation/{ => admin-guide}/cgroup-v1/net_cls.rst | 0
Documentation/{ => admin-guide}/cgroup-v1/net_prio.rst | 0
Documentation/{ => admin-guide}/cgroup-v1/pids.rst | 0
Documentation/{ => admin-guide}/cgroup-v1/rdma.rst | 0
Documentation/admin-guide/cgroup-v2.rst | 2 +-
Documentation/admin-guide/index.rst | 1 +
Documentation/admin-guide/kernel-parameters.txt | 4 ++--
Documentation/admin-guide/mm/numa_memory_policy.rst | 2 +-
Documentation/block/bfq-iosched.rst | 2 +-
Documentation/filesystems/tmpfs.txt | 2 +-
Documentation/kernel-per-CPU-kthreads.txt | 2 +-
Documentation/scheduler/sched-deadline.rst | 2 +-
Documentation/scheduler/sched-design-CFS.rst | 2 +-
Documentation/scheduler/sched-rt-group.rst | 2 +-
Documentation/vm/numa.rst | 4 ++--
Documentation/vm/page_migration.rst | 2 +-
Documentation/vm/unevictable-lru.rst | 2 +-
Documentation/x86/x86_64/fake-numa-for-cpusets.rst | 4 ++--
MAINTAINERS | 4 ++--
block/Kconfig | 2 +-
include/linux/cgroup-defs.h | 2 +-
include/uapi/linux/bpf.h | 2 +-
init/Kconfig | 4 ++--
kernel/cgroup/cpuset.c | 2 +-
security/device_cgroup.c | 2 +-
tools/include/uapi/linux/bpf.h | 2 +-
36 files changed, 32 insertions(+), 33 deletions(-)
rename Documentation/{ => admin-guide}/cgroup-v1/blkio-controller.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/cgroups.rst (99%)
rename Documentation/{ => admin-guide}/cgroup-v1/cpuacct.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/cpusets.rst (99%)
rename Documentation/{ => admin-guide}/cgroup-v1/devices.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/freezer-subsystem.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/hugetlb.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/index.rst (97%)
rename Documentation/{ => admin-guide}/cgroup-v1/memcg_test.rst (98%)
rename Documentation/{ => admin-guide}/cgroup-v1/memory.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/net_cls.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/net_prio.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/pids.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/rdma.rst (100%)Documentation/admin-guide/cgroup-v1/blkio-controller.rst renamed from Documentation/cgroup-v1/blkio-controller.rst +0 -0
Documentation/admin-guide/cgroup-v1/cgroups.rst renamed from Documentation/cgroup-v1/cgroups.rst +2 -2
@@ -3,7 +3,7 @@ Control Groups ============== Written by Paul Menage <[email protected]> based on -Documentation/cgroup-v1/cpusets.rst +Documentation/admin-guide/cgroup-v1/cpusets.rst Original copyright statements from cpusets.txt:
@@ -76,7 +76,7 @@ On their own, the only use for cgroups is for simple job tracking. The intention is that other subsystems hook into the generic cgroup support to provide new attributes for cgroups, such as accounting/limiting the resources which processes in a cgroup can -access. For example, cpusets (see Documentation/cgroup-v1/cpusets.rst) allow +access. For example, cpusets (see Documentation/admin-guide/cgroup-v1/cpusets.rst) allow you to associate a set of CPUs and a set of memory nodes with the tasks in each cgroup.
Documentation/admin-guide/cgroup-v1/cpuacct.rst renamed from Documentation/cgroup-v1/cpuacct.rst +0 -0
Documentation/admin-guide/cgroup-v1/cpusets.rst renamed from Documentation/cgroup-v1/cpusets.rst +1 -1
@@ -49,7 +49,7 @@ hooks, beyond what is already present, required to manage dynamic job placement on large systems. Cpusets use the generic cgroup subsystem described in -Documentation/cgroup-v1/cgroups.rst. +Documentation/admin-guide/cgroup-v1/cgroups.rst. Requests by a task, using the sched_setaffinity(2) system call to include CPUs in its CPU affinity mask, and using the mbind(2) and
Documentation/admin-guide/cgroup-v1/devices.rst renamed from Documentation/cgroup-v1/devices.rst +0 -0
Documentation/admin-guide/cgroup-v1/freezer-subsystem.rst renamed from Documentation/cgroup-v1/freezer-subsystem.rst +0 -0
Documentation/admin-guide/cgroup-v1/hugetlb.rst renamed from Documentation/cgroup-v1/hugetlb.rst +0 -0
Documentation/admin-guide/cgroup-v1/index.rst renamed from Documentation/cgroup-v1/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ======================== Control Groups version 1 ========================
Documentation/admin-guide/cgroup-v1/memcg_test.rst renamed from Documentation/cgroup-v1/memcg_test.rst +2 -2
@@ -10,7 +10,7 @@ Because VM is getting complex (one of reasons is memcg...), memcg's behavior is complex. This is a document for memcg's internal behavior. Please note that implementation details can be changed. -(*) Topics on API should be in Documentation/cgroup-v1/memory.rst) +(*) Topics on API should be in Documentation/admin-guide/cgroup-v1/memory.rst) 0. How to record usage ? ========================
@@ -327,7 +327,7 @@ Under below explanation, we assume CONFIG_MEM_RES_CTRL_SWAP=y. You can see charges have been moved by reading ``*.usage_in_bytes`` or memory.stat of both A and B. - See 8.2 of Documentation/cgroup-v1/memory.rst to see what value should + See 8.2 of Documentation/admin-guide/cgroup-v1/memory.rst to see what value should be written to move_charge_at_immigrate. 9.10 Memory thresholds
Documentation/admin-guide/cgroup-v1/memory.rst renamed from Documentation/cgroup-v1/memory.rst +0 -0
Documentation/admin-guide/cgroup-v1/net_cls.rst renamed from Documentation/cgroup-v1/net_cls.rst +0 -0
Documentation/admin-guide/cgroup-v1/net_prio.rst renamed from Documentation/cgroup-v1/net_prio.rst +0 -0
Documentation/admin-guide/cgroup-v1/pids.rst renamed from Documentation/cgroup-v1/pids.rst +0 -0
Documentation/admin-guide/cgroup-v1/rdma.rst renamed from Documentation/cgroup-v1/rdma.rst +0 -0
Documentation/admin-guide/cgroup-v2.rst +1 -1
@@ -9,7 +9,7 @@ This is the authoritative documentation on the design, interface and conventions of cgroup v2. It describes all userland-visible aspects of cgroup including core and specific controller behaviors. All future changes must be reflected in this document. Documentation for -v1 is available under Documentation/cgroup-v1/. +v1 is available under Documentation/admin-guide/cgroup-v1/. .. CONTENTS
Documentation/admin-guide/index.rst +1 -0
@@ -59,6 +59,7 @@ configure specific aspects of kernel behavior to your liking. initrd cgroup-v2 + cgroup-v1/index serial-console braille-console parport
Documentation/admin-guide/kernel-parameters.txt +2 -2
@@ -4115,7 +4115,7 @@ relax_domain_level= [KNL, SMP] Set scheduler's default relax_domain_level. - See Documentation/cgroup-v1/cpusets.rst. + See Documentation/admin-guide/cgroup-v1/cpusets.rst. reserve= [KNL,BUGS] Force kernel to ignore I/O ports or memory Format: <base1>,<size1>[,<base2>,<size2>,...]
@@ -4625,7 +4625,7 @@ swapaccount=[0|1] [KNL] Enable accounting of swap in memory resource controller if no parameter or 1 is given or disable - it if 0 is given (See Documentation/cgroup-v1/memory.rst) + it if 0 is given (See Documentation/admin-guide/cgroup-v1/memory.rst) swiotlb= [ARM,IA-64,PPC,MIPS,X86] Format: { <int> | force | noforce }
Documentation/admin-guide/mm/numa_memory_policy.rst +1 -1
@@ -15,7 +15,7 @@ document attempts to describe the concepts and APIs of the 2.6 memory policy support. Memory policies should not be confused with cpusets -(``Documentation/cgroup-v1/cpusets.rst``) +(``Documentation/admin-guide/cgroup-v1/cpusets.rst``) which is an administrative mechanism for restricting the nodes from which memory may be allocated by a set of processes. Memory policies are a programming interface that a NUMA-aware application can take advantage of. When
Documentation/block/bfq-iosched.rst +1 -1
@@ -547,7 +547,7 @@ As for cgroups-v1 (blkio controller), the exact set of stat files created, and kept up-to-date by bfq, depends on whether CONFIG_BFQ_CGROUP_DEBUG is set. If it is set, then bfq creates all the stat files documented in -Documentation/cgroup-v1/blkio-controller.rst. If, instead, +Documentation/admin-guide/cgroup-v1/blkio-controller.rst. If, instead, CONFIG_BFQ_CGROUP_DEBUG is not set, then bfq creates only the files:: blkio.bfq.io_service_bytes
Documentation/filesystems/tmpfs.txt +1 -1
@@ -98,7 +98,7 @@ A memory policy with a valid NodeList will be saved, as specified, for use at file creation time. When a task allocates a file in the file system, the mount option memory policy will be applied with a NodeList, if any, modified by the calling task's cpuset constraints -[See Documentation/cgroup-v1/cpusets.rst] and any optional flags, listed +[See Documentation/admin-guide/cgroup-v1/cpusets.rst] and any optional flags, listed below. If the resulting NodeLists is the empty set, the effective memory policy for the file will revert to "default" policy.
Documentation/kernel-per-CPU-kthreads.txt +1 -1
@@ -12,7 +12,7 @@ References - Documentation/IRQ-affinity.txt: Binding interrupts to sets of CPUs. -- Documentation/cgroup-v1: Using cgroups to bind tasks to sets of CPUs. +- Documentation/admin-guide/cgroup-v1: Using cgroups to bind tasks to sets of CPUs. - man taskset: Using the taskset command to bind tasks to sets of CPUs.
Documentation/scheduler/sched-deadline.rst +1 -1
@@ -669,7 +669,7 @@ Deadline Task Scheduling -deadline tasks cannot have an affinity mask smaller that the entire root_domain they are created on. However, affinities can be specified - through the cpuset facility (Documentation/cgroup-v1/cpusets.rst). + through the cpuset facility (Documentation/admin-guide/cgroup-v1/cpusets.rst). 5.1 SCHED_DEADLINE and cpusets HOWTO ------------------------------------
Documentation/scheduler/sched-design-CFS.rst +1 -1
@@ -222,7 +222,7 @@ SCHED_BATCH) tasks. These options need CONFIG_CGROUPS to be defined, and let the administrator create arbitrary groups of tasks, using the "cgroup" pseudo filesystem. See - Documentation/cgroup-v1/cgroups.rst for more information about this filesystem. + Documentation/admin-guide/cgroup-v1/cgroups.rst for more information about this filesystem. When CONFIG_FAIR_GROUP_SCHED is defined, a "cpu.shares" file is created for each group created using the pseudo filesystem. See example steps below to create
Documentation/scheduler/sched-rt-group.rst +1 -1
@@ -133,7 +133,7 @@ This uses the cgroup virtual file system and "<cgroup>/cpu.rt_runtime_us" to control the CPU time reserved for each control group. For more information on working with control groups, you should read -Documentation/cgroup-v1/cgroups.rst as well. +Documentation/admin-guide/cgroup-v1/cgroups.rst as well. Group settings are checked against the following limits in order to keep the configuration schedulable:
Documentation/vm/numa.rst +2 -2
@@ -67,7 +67,7 @@ nodes. Each emulated node will manage a fraction of the underlying cells' physical memory. NUMA emluation is useful for testing NUMA kernel and application features on non-NUMA platforms, and as a sort of memory resource management mechanism when used together with cpusets. -[see Documentation/cgroup-v1/cpusets.rst] +[see Documentation/admin-guide/cgroup-v1/cpusets.rst] For each node with memory, Linux constructs an independent memory management subsystem, complete with its own free page lists, in-use page lists, usage
@@ -114,7 +114,7 @@ allocation behavior using Linux NUMA memory policy. [see System administrators can restrict the CPUs and nodes' memories that a non- privileged user can specify in the scheduling or NUMA commands and functions -using control groups and CPUsets. [see Documentation/cgroup-v1/cpusets.rst] +using control groups and CPUsets. [see Documentation/admin-guide/cgroup-v1/cpusets.rst] On architectures that do not hide memoryless nodes, Linux will include only zones [nodes] with memory in the zonelists. This means that for a memoryless
Documentation/vm/page_migration.rst +1 -1
@@ -41,7 +41,7 @@ locations. Larger installations usually partition the system using cpusets into sections of nodes. Paul Jackson has equipped cpusets with the ability to move pages when a task is moved to another cpuset (See -Documentation/cgroup-v1/cpusets.rst). +Documentation/admin-guide/cgroup-v1/cpusets.rst). Cpusets allows the automation of process locality. If a task is moved to a new cpuset then also all its pages are moved with it so that the performance of the process does not sink dramatically. Also the pages
Documentation/vm/unevictable-lru.rst +1 -1
@@ -98,7 +98,7 @@ Memory Control Group Interaction -------------------------------- The unevictable LRU facility interacts with the memory control group [aka -memory controller; see Documentation/cgroup-v1/memory.rst] by extending the +memory controller; see Documentation/admin-guide/cgroup-v1/memory.rst] by extending the lru_list enum. The memory controller data structure automatically gets a per-zone unevictable
Documentation/x86/x86_64/fake-numa-for-cpusets.rst +2 -2
@@ -15,7 +15,7 @@ assign them to cpusets and their attached tasks. This is a way of limiting the amount of system memory that are available to a certain class of tasks. For more information on the features of cpusets, see -Documentation/cgroup-v1/cpusets.rst. +Documentation/admin-guide/cgroup-v1/cpusets.rst. There are a number of different configurations you can use for your needs. For more information on the numa=fake command line option and its various ways of configuring fake nodes, see Documentation/x86/x86_64/boot-options.rst.
@@ -40,7 +40,7 @@ A machine may be split as follows with "numa=fake=4*512," as reported by dmesg:: On node 3 totalpages: 131072 Now following the instructions for mounting the cpusets filesystem from -Documentation/cgroup-v1/cpusets.rst, you can assign fake nodes (i.e. contiguous memory +Documentation/admin-guide/cgroup-v1/cpusets.rst, you can assign fake nodes (i.e. contiguous memory address spaces) to individual cpusets:: [root@xroads /]# mkdir exampleset
MAINTAINERS +2 -2
@@ -4119,7 +4119,7 @@ L: [email protected] T: git git://git.kernel.org/pub/scm/linux/kernel/git/tj/cgroup.git S: Maintained F: Documentation/admin-guide/cgroup-v2.rst -F: Documentation/cgroup-v1/ +F: Documentation/admin-guide/cgroup-v1/ F: include/linux/cgroup* F: kernel/cgroup/
@@ -4130,7 +4130,7 @@ W: http://www.bullopensource.org/cpuset/ W: http://oss.sgi.com/projects/cpusets/ T: git git://git.kernel.org/pub/scm/linux/kernel/git/tj/cgroup.git S: Maintained -F: Documentation/cgroup-v1/cpusets.rst +F: Documentation/admin-guide/cgroup-v1/cpusets.rst F: include/linux/cpuset.h F: kernel/cgroup/cpuset.c
block/Kconfig +1 -1
@@ -89,7 +89,7 @@ config BLK_DEV_THROTTLING one needs to mount and use blkio cgroup controller for creating cgroups and specifying per device IO rate policies. - See Documentation/cgroup-v1/blkio-controller.rst for more information. + See Documentation/admin-guide/cgroup-v1/blkio-controller.rst for more information. config BLK_DEV_THROTTLING_LOW bool "Block throttling .low limit interface support (EXPERIMENTAL)"
include/linux/cgroup-defs.h +1 -1
@@ -624,7 +624,7 @@ struct cftype {/* * Control Group subsystem type. -* See Documentation/cgroup-v1/cgroups.rst for details +* See Documentation/admin-guide/cgroup-v1/cgroups.rst for details */ struct cgroup_subsys {struct cgroup_subsys_state *(*css_alloc)(struct cgroup_subsys_state *parent_css);
include/uapi/linux/bpf.h +1 -1
@@ -803,7 +803,7 @@ union bpf_attr {* based on a user-provided identifier for all traffic coming from * the tasks belonging to the related cgroup. See also the related * kernel documentation, available from the Linux sources in file -* *Documentation/cgroup-v1/net_cls.rst*. +* *Documentation/admin-guide/cgroup-v1/net_cls.rst*. * * The Linux kernel has two versions for cgroups: there are * cgroups v1 and cgroups v2. Both are available to users, who can
init/Kconfig +2 -2
@@ -797,7 +797,7 @@ menuconfig CGROUPS controls or device isolation. See - Documentation/scheduler/sched-design-CFS.rst (CFS) - - Documentation/cgroup-v1/ (features for grouping, isolation + - Documentation/admin-guide/cgroup-v1/ (features for grouping, isolation and resource control) Say N if unsure.
@@ -859,7 +859,7 @@ config BLK_CGROUP CONFIG_CFQ_GROUP_IOSCHED=y; for enabling throttling policy, set CONFIG_BLK_DEV_THROTTLING=y. - See Documentation/cgroup-v1/blkio-controller.rst for more information. + See Documentation/admin-guide/cgroup-v1/blkio-controller.rst for more information. config CGROUP_WRITEBACK bool
kernel/cgroup/cpuset.c +1 -1
@@ -729,7 +729,7 @@ static inline int nr_cpusets(void)* load balancing domains (sched domains) as specified by that partial * partition. * -* See "What is sched_load_balance" in Documentation/cgroup-v1/cpusets.rst +* See "What is sched_load_balance" in Documentation/admin-guide/cgroup-v1/cpusets.rst * for a background explanation of this. * * Does not return errors, on the theory that the callers of this
security/device_cgroup.c +1 -1
@@ -509,7 +509,7 @@ static inline int may_allow_all(struct dev_cgroup *parent)* This is one of the three key functions for hierarchy implementation. * This function is responsible for re-evaluating all the cgroup's active * exceptions due to a parent's exception change. -* Refer to Documentation/cgroup-v1/devices.rst for more details. +* Refer to Documentation/admin-guide/cgroup-v1/devices.rst for more details. */ static void revalidate_active_exceptions (struct dev_cgroup *devcg) {
tools/include/uapi/linux/bpf.h +1 -1
@@ -803,7 +803,7 @@ union bpf_attr {* based on a user-provided identifier for all traffic coming from * the tasks belonging to the related cgroup. See also the related * kernel documentation, available from the Linux sources in file -* *Documentation/cgroup-v1/net_cls.rst*. +* *Documentation/admin-guide/cgroup-v1/net_cls.rst*. * * The Linux kernel has two versions for cgroups: there are * cgroups v1 and cgroups v2. Both are available to users, who can
Signature · 1 line
2.21.0
PATCH 28/39 docs: admin-guide: add a series of orphaned documents
In reply to Mauro Carvalho ChehabThere are lots of documents that belong to the admin-guide but are on random places (most under Documentation root dir).
Move them to the admin guide.
---
Documentation/ABI/stable/sysfs-devices-node | 2 +-
Documentation/ABI/testing/procfs-diskstats | 2 +-
Documentation/ABI/testing/sysfs-block | 2 +-
.../ABI/testing/sysfs-devices-system-cpu | 4 ++--
.../{btmrvl.txt => admin-guide/btmrvl.rst} | 0
.../clearing-warn-once.rst} | 0
.../{cpu-load.txt => admin-guide/cpu-load.rst} | 0
.../cputopology.rst} | 0
.../admin-guide/device-mapper/statistics.rst | 4 ++--
.../{efi-stub.txt => admin-guide/efi-stub.rst} | 0
.../{highuid.txt => admin-guide/highuid.rst} | 0
Documentation/admin-guide/hw-vuln/l1tf.rst | 2 +-
.../hw_random.rst} | 0
Documentation/admin-guide/index.rst | 17 +++++++++++++++++
.../{iostats.txt => admin-guide/iostats.rst} | 0
Documentation/admin-guide/kernel-parameters.txt | 2 +-
.../kernel-per-CPU-kthreads.rst} | 0
.../lcd-panel-cgram.rst | 2 --
Documentation/{ldm.txt => admin-guide/ldm.rst} | 0
.../lockup-watchdogs.rst} | 0
.../mm/cma_debugfs.rst} | 2 --
Documentation/admin-guide/mm/index.rst | 1 +
.../{numastat.txt => admin-guide/numastat.rst} | 0
Documentation/{pnp.txt => admin-guide/pnp.rst} | 0
Documentation/{rtc.txt => admin-guide/rtc.rst} | 0
.../{svga.txt => admin-guide/svga.rst} | 0
Documentation/admin-guide/sysctl/kernel.rst | 2 +-
.../video-output.rst} | 0
Documentation/fb/vesafb.rst | 2 +-
Documentation/x86/topology.rst | 2 +-
MAINTAINERS | 12 ++++++------
arch/arm/Kconfig | 2 +-
arch/parisc/Kconfig | 2 +-
arch/sh/Kconfig | 2 +-
arch/sparc/Kconfig | 2 +-
arch/x86/Kconfig | 4 ++--
block/partitions/Kconfig | 2 +-
drivers/char/Kconfig | 4 ++--
drivers/char/hw_random/core.c | 2 +-
include/linux/hw_random.h | 2 +-
40 files changed, 47 insertions(+), 33 deletions(-)
rename Documentation/{btmrvl.txt => admin-guide/btmrvl.rst} (100%)
rename Documentation/{clearing-warn-once.txt => admin-guide/clearing-warn-once.rst} (100%)
rename Documentation/{cpu-load.txt => admin-guide/cpu-load.rst} (100%)
rename Documentation/{cputopology.txt => admin-guide/cputopology.rst} (100%)
rename Documentation/{efi-stub.txt => admin-guide/efi-stub.rst} (100%)
rename Documentation/{highuid.txt => admin-guide/highuid.rst} (100%)
rename Documentation/{hw_random.txt => admin-guide/hw_random.rst} (100%)
rename Documentation/{iostats.txt => admin-guide/iostats.rst} (100%)
rename Documentation/{kernel-per-CPU-kthreads.txt => admin-guide/kernel-per-CPU-kthreads.rst} (100%)
rename Documentation/{auxdisplay => admin-guide}/lcd-panel-cgram.rst (99%)
rename Documentation/{ldm.txt => admin-guide/ldm.rst} (100%)
rename Documentation/{lockup-watchdogs.txt => admin-guide/lockup-watchdogs.rst} (100%)
rename Documentation/{cma/debugfs.rst => admin-guide/mm/cma_debugfs.rst} (98%)
rename Documentation/{numastat.txt => admin-guide/numastat.rst} (100%)
rename Documentation/{pnp.txt => admin-guide/pnp.rst} (100%)
rename Documentation/{rtc.txt => admin-guide/rtc.rst} (100%)
rename Documentation/{svga.txt => admin-guide/svga.rst} (100%)
rename Documentation/{video-output.txt => admin-guide/video-output.rst} (100%)Documentation/ABI/stable/sysfs-devices-node +1 -1
@@ -61,7 +61,7 @@ Date: October 2002 Contact: Linux Memory Management list <[email protected]> Description: The node's hit/miss statistics, in units of pages. - See Documentation/numastat.txt + See Documentation/admin-guide/numastat.rst What: /sys/devices/system/node/nodeX/distance Date: October 2002
Documentation/ABI/testing/procfs-diskstats +1 -1
@@ -29,4 +29,4 @@ Description: 17 - sectors discarded 18 - time spent discarding - For more details refer to Documentation/iostats.txt + For more details refer to Documentation/admin-guide/iostats.rst
Documentation/ABI/testing/sysfs-block +1 -1
@@ -15,7 +15,7 @@ Description: 9 - I/Os currently in progress 10 - time spent doing I/Os (ms) 11 - weighted time spent doing I/Os (ms) - For more details refer Documentation/iostats.txt + For more details refer Documentation/admin-guide/iostats.rst What: /sys/block/<disk>/<part>/stat
Documentation/ABI/testing/sysfs-devices-system-cpu +2 -2
@@ -34,7 +34,7 @@ Description: CPU topology files that describe kernel limits related to present: cpus that have been identified as being present in the system. - See Documentation/cputopology.txt for more information. + See Documentation/admin-guide/cputopology.rst for more information. What: /sys/devices/system/cpu/probe
@@ -103,7 +103,7 @@ Description: CPU topology files that describe a logical CPU's relationship thread_siblings_list: human-readable list of cpu#'s hardware threads within the same core as cpu# - See Documentation/cputopology.txt for more information. + See Documentation/admin-guide/cputopology.rst for more information. What: /sys/devices/system/cpu/cpuidle/current_driver
Documentation/admin-guide/btmrvl.rst renamed from Documentation/btmrvl.txt +0 -0
Documentation/admin-guide/clearing-warn-once.rst renamed from Documentation/clearing-warn-once.txt +0 -0
Documentation/admin-guide/cpu-load.rst renamed from Documentation/cpu-load.txt +0 -0
Documentation/admin-guide/cputopology.rst renamed from Documentation/cputopology.txt +0 -0
Documentation/admin-guide/device-mapper/statistics.rst +2 -2
@@ -13,7 +13,7 @@ the range specified. The I/O statistics counters for each step-sized area of a region are in the same format as `/sys/block/*/stat` or `/proc/diskstats` (see: -Documentation/iostats.txt). But two extra counters (12 and 13) are +Documentation/admin-guide/iostats.rst). But two extra counters (12 and 13) are provided: total time spent reading and writing. When the histogram argument is used, the 14th parameter is reported that represents the histogram of latencies. All these counters may be accessed by sending
@@ -151,7 +151,7 @@ Messages The first 11 counters have the same meaning as `/sys/block/*/stat or /proc/diskstats`. - Please refer to Documentation/iostats.txt for details. + Please refer to Documentation/admin-guide/iostats.rst for details. 1. the number of reads completed 2. the number of reads merged
Documentation/admin-guide/efi-stub.rst renamed from Documentation/efi-stub.txt +0 -0
Documentation/admin-guide/highuid.rst renamed from Documentation/highuid.txt +0 -0
Documentation/admin-guide/hw-vuln/l1tf.rst +1 -1
@@ -241,7 +241,7 @@ Guest mitigation mechanisms For further information about confining guests to a single or to a group of cores consult the cpusets documentation: - https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.rst + https://www.kernel.org/doc/Documentation/admin-guide/cgroup-v1/cpusets.rst .. _interrupt_isolation:
Documentation/admin-guide/hw_random.rst renamed from Documentation/hw_random.txt +0 -0
Documentation/admin-guide/index.rst +17 -0
@@ -84,8 +84,25 @@ configure specific aspects of kernel behavior to your liking. perf-security acpi/index aoe/index + btmrvl + clearing-warn-once + cpu-load + cputopology device-mapper/index + efi-stub + highuid + hw_random + iostats + kernel-per-CPU-kthreads laptops/index + lcd-panel-cgram + ldm + lockup-watchdogs + numastat + pnp + rtc + svga + video-output .. only:: subproject and html
Documentation/admin-guide/iostats.rst renamed from Documentation/iostats.txt +0 -0
Documentation/admin-guide/kernel-parameters.txt +1 -1
@@ -5092,7 +5092,7 @@ vga= [BOOT,X86-32] Select a particular video mode See Documentation/x86/boot.rst and - Documentation/svga.txt. + Documentation/admin-guide/svga.rst. Use vga=ask for menu. This is actually a boot loader parameter; the value is passed to the kernel using a special protocol.
Documentation/admin-guide/kernel-per-CPU-kthreads.rst renamed from Documentation/kernel-per-CPU-kthreads.txt +0 -0
Documentation/admin-guide/lcd-panel-cgram.rst renamed from Documentation/auxdisplay/lcd-panel-cgram.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ====================================== Parallel port LCD/Keypad Panel support ======================================
Documentation/admin-guide/ldm.rst renamed from Documentation/ldm.txt +0 -0
Documentation/admin-guide/lockup-watchdogs.rst renamed from Documentation/lockup-watchdogs.txt +0 -0
Documentation/admin-guide/mm/cma_debugfs.rst renamed from Documentation/cma/debugfs.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ===================== CMA Debugfs Interface =====================
Documentation/admin-guide/mm/index.rst +1 -0
@@ -26,6 +26,7 @@ the Linux memory management. :maxdepth: 1 concepts + cma_debugfs hugetlbpage idle_page_tracking ksm
Documentation/admin-guide/numastat.rst renamed from Documentation/numastat.txt +0 -0
Documentation/admin-guide/pnp.rst renamed from Documentation/pnp.txt +0 -0
Documentation/admin-guide/rtc.rst renamed from Documentation/rtc.txt +0 -0
Documentation/admin-guide/svga.rst renamed from Documentation/svga.txt +0 -0
Documentation/admin-guide/sysctl/kernel.rst +1 -1
@@ -327,7 +327,7 @@ when a hard lockup is detected. 0 - don't panic on hard lockup 1 - panic on hard lockup -See Documentation/lockup-watchdogs.txt for more information. This can +See Documentation/admin-guide/lockup-watchdogs.rst for more information. This can also be set using the nmi_watchdog kernel parameter.
Documentation/admin-guide/video-output.rst renamed from Documentation/video-output.txt +0 -0
Documentation/fb/vesafb.rst +1 -1
@@ -30,7 +30,7 @@ How to use it? ============== Switching modes is done using the vga=... boot parameter. Read -Documentation/svga.txt for details. +Documentation/admin-guide/svga.rst for details. You should compile in both vgacon (for text mode) and vesafb (for graphics mode). Which of them takes over the console depends on
Documentation/x86/topology.rst +1 -1
@@ -9,7 +9,7 @@ representation in the kernel. Update/change when doing changes to the respective code. The architecture-agnostic topology definitions are in -Documentation/cputopology.txt. This file holds x86-specific +Documentation/admin-guide/cputopology.rst. This file holds x86-specific differences/specialities which must not necessarily apply to the generic definitions. Thus, the way to read up on Linux topology on x86 is to start with the generic one and look at this one in parallel for the x86 specifics.
MAINTAINERS +6 -6
@@ -6054,7 +6054,7 @@ M: Ard Biesheuvel <[email protected]> L: [email protected] T: git git://git.kernel.org/pub/scm/linux/kernel/git/efi/efi.git S: Maintained -F: Documentation/efi-stub.txt +F: Documentation/admin-guide/efi-stub.rst F: arch/*/kernel/efi.c F: arch/x86/boot/compressed/eboot.[ch] F: arch/*/include/asm/efi.h
@@ -7033,7 +7033,7 @@ M: Herbert Xu <[email protected]> L: [email protected] S: Odd fixes F: Documentation/devicetree/bindings/rng/ -F: Documentation/hw_random.txt +F: Documentation/admin-guide/hw_random.rst F: drivers/char/hw_random/ F: include/linux/hw_random.h
@@ -9347,7 +9347,7 @@ M: "Richard Russon (FlatCap)" <[email protected]> L: [email protected] W: http://www.linux-ntfs.org/content/view/19/37/ S: Maintained -F: Documentation/ldm.txt +F: Documentation/admin-guide/ldm.rst F: block/partitions/ldm.* LSILOGIC MPT FUSION DRIVERS (FC/SAS/SPI)
@@ -12000,7 +12000,7 @@ PARALLEL LCD/KEYPAD PANEL DRIVER M: Willy Tarreau <[email protected]> M: Ksenija Stanojevic <[email protected]> S: Odd Fixes -F: Documentation/auxdisplay/lcd-panel-cgram.rst +F: Documentation/admin-guide/lcd-panel-cgram.rst F: drivers/auxdisplay/panel.c PARALLEL PORT SUBSYSTEM
@@ -13419,7 +13419,7 @@ Q: http://patchwork.ozlabs.org/project/rtc-linux/list/ T: git git://git.kernel.org/pub/scm/linux/kernel/git/abelloni/linux.git S: Maintained F: Documentation/devicetree/bindings/rtc/ -F: Documentation/rtc.txt +F: Documentation/admin-guide/rtc.rst F: drivers/rtc/ F: include/linux/rtc.h F: include/uapi/linux/rtc.h
@@ -15248,7 +15248,7 @@ SVGA HANDLING M: Martin Mares <[email protected]> L: [email protected] S: Maintained -F: Documentation/svga.txt +F: Documentation/admin-guide/svga.rst F: arch/x86/boot/video* SWIOTLB SUBSYSTEM
arch/arm/Kconfig +1 -1
@@ -1286,7 +1286,7 @@ config SMP will run faster if you say N here. See also <file:Documentation/x86/i386/IO-APIC.rst>, - <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO available at + <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO available at <http://tldp.org/HOWTO/SMP-HOWTO.html>. If you don't know what to do here, say N.
arch/parisc/Kconfig +1 -1
@@ -277,7 +277,7 @@ config SMP machines, but will use only one CPU of a multiprocessor machine. On a uniprocessor machine, the kernel will run faster if you say N. - See also <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO + See also <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO available at <http://www.tldp.org/docs.html#howto>. If you don't know what to do here, say N.
arch/sh/Kconfig +1 -1
@@ -679,7 +679,7 @@ config SMP People using multiprocessor machines who say Y here should also say Y to "Enhanced Real Time Clock Support", below. - See also <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO + See also <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO available at <http://www.tldp.org/docs.html#howto>. If you don't know what to do here, say N.
arch/sparc/Kconfig +1 -1
@@ -180,7 +180,7 @@ config SMP Y to "Enhanced Real Time Clock Support", below. The "Advanced Power Management" code will be disabled if you say Y here. - See also <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO + See also <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO available at <http://www.tldp.org/docs.html#howto>. If you don't know what to do here, say N.
arch/x86/Kconfig +2 -2
@@ -402,7 +402,7 @@ config SMP Management" code will be disabled if you say Y here. See also <file:Documentation/x86/i386/IO-APIC.rst>, - <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO available at + <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO available at <http://www.tldp.org/docs.html#howto>. If you don't know what to do here, say N.
@@ -1959,7 +1959,7 @@ config EFI_STUB This kernel feature allows a bzImage to be loaded directly by EFI firmware without the use of a bootloader. - See Documentation/efi-stub.txt for more information. + See Documentation/admin-guide/efi-stub.rst for more information. config EFI_MIXED bool "EFI mixed-mode support"
block/partitions/Kconfig +1 -1
@@ -194,7 +194,7 @@ config LDM_PARTITION Normal partitions are now called Basic Disks under Windows 2000, XP, and Vista. - For a fuller description read <file:Documentation/ldm.txt>. + For a fuller description read <file:Documentation/admin-guide/ldm.rst>. If unsure, say N.
drivers/char/Kconfig +2 -2
@@ -291,7 +291,7 @@ config RTC and set the RTC in an SMP compatible fashion. If you think you have a use for such a device (such as periodic data - sampling), then say Y here, and read <file:Documentation/rtc.txt> + sampling), then say Y here, and read <file:Documentation/admin-guide/rtc.rst> for details. To compile this driver as a module, choose M here: the
@@ -313,7 +313,7 @@ config JS_RTC /dev/rtc. If you think you have a use for such a device (such as periodic data - sampling), then say Y here, and read <file:Documentation/rtc.txt> + sampling), then say Y here, and read <file:Documentation/admin-guide/rtc.rst> for details. To compile this driver as a module, choose M here: the
drivers/char/hw_random/core.c +1 -1
@@ -4,7 +4,7 @@* Copyright 2006 Michael Buesch <[email protected]> * Copyright 2005 (c) MontaVista Software, Inc. * -* Please read Documentation/hw_random.txt for details on use. +* Please read Documentation/admin-guide/hw_random.rst for details on use. * * This software may be used and distributed according to the terms * of the GNU General Public License, incorporated herein by reference.
include/linux/hw_random.h +1 -1
@@ -1,7 +1,7 @@/* Hardware Random Number Generator -Please read Documentation/hw_random.txt for details on use. +Please read Documentation/admin-guide/hw_random.rst for details on use. ---------------------------------------------------------- This software may be used and distributed according to the terms
Signature · 1 line
2.21.0
PATCH 29/39 docs: driver-api: add a series of orphaned documents
In reply to Mauro Carvalho ChehabThere are lots of documents under Documentation/*.txt and a few other orphan documents elsehwere that belong to the driver-API book.
Move them to their right place.
---
Documentation/ABI/removed/sysfs-class-rfkill | 2 +-
Documentation/ABI/stable/sysfs-class-rfkill | 2 +-
.../ABI/testing/sysfs-class-switchtec | 2 +-
.../admin-guide/kernel-parameters.txt | 2 +-
.../admin-guide/laptops/thinkpad-acpi.rst | 6 ++---
.../bt8xxgpio.rst} | 0
.../{connector => driver-api}/connector.rst | 2 +-
.../{console => driver-api}/console.rst | 2 +-
.../{dcdbas.txt => driver-api/dcdbas.rst} | 0
.../{dell_rbu.txt => driver-api/dell_rbu.rst} | 0
.../{EDID/howto.rst => driver-api/edid.rst} | 2 +-
.../{eisa.txt => driver-api/eisa.rst} | 0
Documentation/driver-api/index.rst | 26 +++++++++++++++++++
Documentation/{isa.txt => driver-api/isa.rst} | 0
.../{isapnp.txt => driver-api/isapnp.rst} | 0
.../pblk.txt => driver-api/lightnvm-pblk.rst} | 0
.../men-chameleon-bus.rst} | 0
Documentation/{ntb.txt => driver-api/ntb.rst} | 0
Documentation/{nvmem => driver-api}/nvmem.rst | 2 +-
.../parport-lowlevel.rst} | 0
.../{pti => driver-api}/pti_intel_mid.rst | 2 +-
Documentation/{pwm.txt => driver-api/pwm.rst} | 0
.../{rfkill.txt => driver-api/rfkill.rst} | 0
.../{sgi-ioc4.txt => driver-api/sgi-ioc4.rst} | 0
.../{SM501.txt => driver-api/sm501.rst} | 0
.../smsc_ece1099.rst} | 0
.../switchtec.rst} | 2 +-
.../sync_file.rst} | 0
.../vfio-mediated-device.rst} | 2 +-
.../{vfio.txt => driver-api/vfio.rst} | 0
.../{xillybus.txt => driver-api/xillybus.rst} | 0
.../{zorro.txt => driver-api/zorro.rst} | 0
Documentation/fb/fbcon.rst | 4 +--
Documentation/s390/vfio-ccw.rst | 6 ++---
Documentation/w1/w1.netlink | 2 +-
MAINTAINERS | 22 ++++++++--------
Next/merge.log | 4 +--
drivers/dma-buf/Kconfig | 2 +-
drivers/gpio/Kconfig | 2 +-
drivers/gpu/drm/Kconfig | 2 +-
drivers/pci/switch/Kconfig | 2 +-
drivers/platform/x86/Kconfig | 4 +--
drivers/platform/x86/dcdbas.c | 2 +-
drivers/platform/x86/dell_rbu.c | 2 +-
drivers/pnp/isapnp/Kconfig | 2 +-
drivers/tty/Kconfig | 2 +-
drivers/vfio/Kconfig | 2 +-
drivers/vfio/mdev/Kconfig | 2 +-
drivers/w1/Kconfig | 2 +-
samples/Kconfig | 2 +-
50 files changed, 73 insertions(+), 47 deletions(-)
rename Documentation/{bt8xxgpio.txt => driver-api/bt8xxgpio.rst} (100%)
rename Documentation/{connector => driver-api}/connector.rst (99%)
rename Documentation/{console => driver-api}/console.rst (99%)
rename Documentation/{dcdbas.txt => driver-api/dcdbas.rst} (100%)
rename Documentation/{dell_rbu.txt => driver-api/dell_rbu.rst} (100%)
rename Documentation/{EDID/howto.rst => driver-api/edid.rst} (98%)
rename Documentation/{eisa.txt => driver-api/eisa.rst} (100%)
rename Documentation/{isa.txt => driver-api/isa.rst} (100%)
rename Documentation/{isapnp.txt => driver-api/isapnp.rst} (100%)
rename Documentation/{lightnvm/pblk.txt => driver-api/lightnvm-pblk.rst} (100%)
rename Documentation/{men-chameleon-bus.txt => driver-api/men-chameleon-bus.rst} (100%)
rename Documentation/{ntb.txt => driver-api/ntb.rst} (100%)
rename Documentation/{nvmem => driver-api}/nvmem.rst (99%)
rename Documentation/{parport-lowlevel.txt => driver-api/parport-lowlevel.rst} (100%)
rename Documentation/{pti => driver-api}/pti_intel_mid.rst (99%)
rename Documentation/{pwm.txt => driver-api/pwm.rst} (100%)
rename Documentation/{rfkill.txt => driver-api/rfkill.rst} (100%)
rename Documentation/{sgi-ioc4.txt => driver-api/sgi-ioc4.rst} (100%)
rename Documentation/{SM501.txt => driver-api/sm501.rst} (100%)
rename Documentation/{smsc_ece1099.txt => driver-api/smsc_ece1099.rst} (100%)
rename Documentation/{switchtec.txt => driver-api/switchtec.rst} (97%)
rename Documentation/{sync_file.txt => driver-api/sync_file.rst} (100%)
rename Documentation/{vfio-mediated-device.txt => driver-api/vfio-mediated-device.rst} (99%)
rename Documentation/{vfio.txt => driver-api/vfio.rst} (100%)
rename Documentation/{xillybus.txt => driver-api/xillybus.rst} (100%)
rename Documentation/{zorro.txt => driver-api/zorro.rst} (100%)Documentation/ABI/removed/sysfs-class-rfkill +1 -1
@@ -1,6 +1,6 @@ rfkill - radio frequency (RF) connector kill switch support -For details to this subsystem look at Documentation/rfkill.txt. +For details to this subsystem look at Documentation/driver-api/rfkill.rst. What: /sys/class/rfkill/rfkill[0-9]+/claim Date: 09-Jul-2007
Documentation/ABI/stable/sysfs-class-rfkill +1 -1
@@ -1,6 +1,6 @@ rfkill - radio frequency (RF) connector kill switch support -For details to this subsystem look at Documentation/rfkill.txt. +For details to this subsystem look at Documentation/driver-api/rfkill.rst. For the deprecated /sys/class/rfkill/*/claim knobs of this interface look in Documentation/ABI/removed/sysfs-class-rfkill.
Documentation/ABI/testing/sysfs-class-switchtec +1 -1
@@ -1,6 +1,6 @@ switchtec - Microsemi Switchtec PCI Switch Management Endpoint -For details on this subsystem look at Documentation/switchtec.txt. +For details on this subsystem look at Documentation/driver-api/switchtec.rst. What: /sys/class/switchtec Date: 05-Jan-2017
Documentation/admin-guide/kernel-parameters.txt +1 -1
@@ -930,7 +930,7 @@ edid/1680x1050.bin, or edid/1920x1080.bin is given and no file with the same name exists. Details and instructions how to build your own EDID data are - available in Documentation/EDID/howto.rst. An EDID + available in Documentation/driver-api/edid.rst. An EDID data set will only be used for a particular connector, if its name and a colon are prepended to the EDID name. Each connector may use a unique EDID data
Documentation/admin-guide/laptops/thinkpad-acpi.rst +3 -3
@@ -643,7 +643,7 @@ Sysfs notes 2010. rfkill controller switch "tpacpi_bluetooth_sw": refer to - Documentation/rfkill.txt for details. + Documentation/driver-api/rfkill.rst for details. Video output control -- /proc/acpi/ibm/video
@@ -1406,7 +1406,7 @@ Sysfs notes 2010. rfkill controller switch "tpacpi_wwan_sw": refer to - Documentation/rfkill.txt for details. + Documentation/driver-api/rfkill.rst for details. EXPERIMENTAL: UWB
@@ -1426,7 +1426,7 @@ Sysfs notes ^^^^^^^^^^^ rfkill controller switch "tpacpi_uwb_sw": refer to - Documentation/rfkill.txt for details. + Documentation/driver-api/rfkill.rst for details. Adaptive keyboard -----------------
Documentation/driver-api/bt8xxgpio.rst renamed from Documentation/bt8xxgpio.txt +0 -0
Documentation/driver-api/connector.rst renamed from Documentation/connector/connector.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ================ Kernel Connector
Documentation/driver-api/console.rst renamed from Documentation/console/console.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 =============== Console Drivers
Documentation/driver-api/dcdbas.rst renamed from Documentation/dcdbas.txt +0 -0
Documentation/driver-api/dell_rbu.rst renamed from Documentation/dell_rbu.txt +0 -0
Documentation/driver-api/edid.rst renamed from Documentation/EDID/howto.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ==== EDID
Documentation/driver-api/eisa.rst renamed from Documentation/eisa.txt +0 -0
Documentation/driver-api/index.rst +26 -0
@@ -68,7 +68,33 @@ available subsections can be seen below. fpga/index acpi/index backlight/lp855x-driver.rst + bt8xxgpio + connector + console + dcdbas + dell_rbu + edid + eisa + isa + isapnp generic-counter + lightnvm-pblk + men-chameleon-bus + ntb + nvmem + parport-lowlevel + pti_intel_mid + pwm + rfkill + sgi-ioc4 + sm501 + smsc_ece1099 + switchtec + sync_file + vfio-mediated-device + vfio + xillybus + zorro .. only:: subproject and html
Documentation/driver-api/isa.rst renamed from Documentation/isa.txt +0 -0
Documentation/driver-api/isapnp.rst renamed from Documentation/isapnp.txt +0 -0
Documentation/driver-api/lightnvm-pblk.rst renamed from Documentation/lightnvm/pblk.txt +0 -0
Documentation/driver-api/men-chameleon-bus.rst renamed from Documentation/men-chameleon-bus.txt +0 -0
Documentation/driver-api/ntb.rst renamed from Documentation/ntb.txt +0 -0
Documentation/driver-api/nvmem.rst renamed from Documentation/nvmem/nvmem.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 =============== NVMEM Subsystem
Documentation/driver-api/parport-lowlevel.rst renamed from Documentation/parport-lowlevel.txt +0 -0
Documentation/driver-api/pti_intel_mid.rst renamed from Documentation/pti/pti_intel_mid.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ============= Intel MID PTI
Documentation/driver-api/pwm.rst renamed from Documentation/pwm.txt +0 -0
Documentation/driver-api/rfkill.rst renamed from Documentation/rfkill.txt +0 -0
Documentation/driver-api/sgi-ioc4.rst renamed from Documentation/sgi-ioc4.txt +0 -0
Documentation/driver-api/sm501.rst renamed from Documentation/SM501.txt +0 -0
Documentation/driver-api/smsc_ece1099.rst renamed from Documentation/smsc_ece1099.txt +0 -0
Documentation/driver-api/switchtec.rst renamed from Documentation/switchtec.txt +1 -1
@@ -97,6 +97,6 @@ the following configuration settings: NT EP BAR 2 will be dynamically configured as a Direct Window, and the configuration file does not need to configure it explicitly. -Please refer to Documentation/ntb.txt in Linux source tree for an overall +Please refer to Documentation/driver-api/ntb.rst in Linux source tree for an overall understanding of the Linux NTB stack. ntb_hw_switchtec works as an NTB Hardware Driver in this stack.
Documentation/driver-api/sync_file.rst renamed from Documentation/sync_file.txt +0 -0
Documentation/driver-api/vfio-mediated-device.rst renamed from Documentation/vfio-mediated-device.txt +1 -1
@@ -408,7 +408,7 @@ card. References ========== -1. See Documentation/vfio.txt for more information on VFIO. +1. See Documentation/driver-api/vfio.rst for more information on VFIO. 2. struct mdev_driver in include/linux/mdev.h 3. struct mdev_parent_ops in include/linux/mdev.h 4. struct vfio_iommu_driver_ops in include/linux/vfio.h
Documentation/driver-api/vfio.rst renamed from Documentation/vfio.txt +0 -0
Documentation/driver-api/xillybus.rst renamed from Documentation/xillybus.txt +0 -0
Documentation/driver-api/zorro.rst renamed from Documentation/zorro.txt +0 -0
Documentation/fb/fbcon.rst +2 -2
@@ -187,7 +187,7 @@ the hardware. Thus, in a VGA console:: Assuming the VGA driver can be unloaded, one must first unbind the VGA driver from the console layer before unloading the driver. The VGA driver cannot be unloaded if it is still bound to the console layer. (See -Documentation/console/console.rst for more information). +Documentation/driver-api/console.rst for more information). This is more complicated in the case of the framebuffer console (fbcon), because fbcon is an intermediate layer between the console and the drivers::
@@ -204,7 +204,7 @@ fbcon. Thus, there is no need to explicitly unbind the fbdev drivers from fbcon. So, how do we unbind fbcon from the console? Part of the answer is in -Documentation/console/console.rst. To summarize: +Documentation/driver-api/console.rst. To summarize: Echo a value to the bind file that represents the framebuffer console driver. So assuming vtcon1 represents fbcon, then::
Documentation/s390/vfio-ccw.rst +3 -3
@@ -38,7 +38,7 @@ every detail. More information/reference could be found here: qemu/hw/s390x/css.c For vfio mediated device framework: -- Documentation/vfio-mediated-device.txt +- Documentation/driver-api/vfio-mediated-device.rst Motivation of vfio-ccw ----------------------
@@ -322,5 +322,5 @@ Reference 2. ESA/390 Common I/O Device Commands manual (IBM Form. No. SA22-7204) 3. https://en.wikipedia.org/wiki/Channel_I/O 4. Documentation/s390/cds.rst -5. Documentation/vfio.txt -6. Documentation/vfio-mediated-device.txt +5. Documentation/driver-api/vfio.rst +6. Documentation/driver-api/vfio-mediated-device.rst
Documentation/w1/w1.netlink +1 -1
@@ -183,7 +183,7 @@ acknowledge number is set to seq+1. Additional documantion, source code examples. ============================================ -1. Documentation/connector +1. Documentation/driver-api/connector.rst 2. http://www.ioremap.net/archive/w1 This archive includes userspace application w1d.c which uses read/write/search commands for all master/slave devices found on the bus.
MAINTAINERS +11 -11
@@ -4603,7 +4603,7 @@ DELL SYSTEMS MANAGEMENT BASE DRIVER (dcdbas) M: Stuart Hayes <[email protected]> L: [email protected] S: Maintained -F: Documentation/dcdbas.txt +F: Documentation/driver-api/dcdbas.rst F: drivers/platform/x86/dcdbas.* DELL WMI NOTIFICATIONS DRIVER
@@ -8409,7 +8409,7 @@ F: drivers/irqchip/ ISA M: William Breathitt Gray <[email protected]> S: Maintained -F: Documentation/isa.txt +F: Documentation/driver-api/isa.rst F: drivers/base/isa.c F: include/linux/isa.h
@@ -8424,7 +8424,7 @@ F: drivers/media/radio/radio-isa* ISAPNP M: Jaroslav Kysela <[email protected]> S: Maintained -F: Documentation/isapnp.txt +F: Documentation/driver-api/isapnp.rst F: drivers/pnp/isapnp/ F: include/linux/isapnp.h
@@ -10309,7 +10309,7 @@ M: Johannes Thumshirn <[email protected]> S: Maintained F: drivers/mcb/ F: include/linux/mcb.h -F: Documentation/men-chameleon-bus.txt +F: Documentation/driver-api/men-chameleon-bus.rst MEN F21BMC (Board Management Controller) M: Andreas Werner <[email protected]>
@@ -12012,7 +12012,7 @@ F: drivers/parport/ F: include/linux/parport*.h F: drivers/char/ppdev.c F: include/uapi/linux/ppdev.h -F: Documentation/parport*.txt +F: Documentation/driver-api/parport*.rst PARAVIRT_OPS INTERFACE M: Juergen Gross <[email protected]>
@@ -12187,7 +12187,7 @@ M: Kurt Schwemmer <[email protected]> M: Logan Gunthorpe <[email protected]> L: [email protected] S: Maintained -F: Documentation/switchtec.txt +F: Documentation/driver-api/switchtec.rst F: Documentation/ABI/testing/sysfs-class-switchtec F: drivers/pci/switch/switchtec* F: include/uapi/linux/switchtec_ioctl.h
@@ -12949,7 +12949,7 @@ M: Thierry Reding <[email protected]> L: [email protected] S: Maintained T: git git://git.kernel.org/pub/scm/linux/kernel/git/thierry.reding/linux-pwm.git -F: Documentation/pwm.txt +F: Documentation/driver-api/pwm.rst F: Documentation/devicetree/bindings/pwm/ F: include/linux/pwm.h F: drivers/pwm/
@@ -13568,7 +13568,7 @@ W: http://wireless.kernel.org/ T: git git://git.kernel.org/pub/scm/linux/kernel/git/jberg/mac80211.git T: git git://git.kernel.org/pub/scm/linux/kernel/git/jberg/mac80211-next.git S: Maintained -F: Documentation/rfkill.txt +F: Documentation/driver-api/rfkill.rst F: Documentation/ABI/stable/sysfs-class-rfkill F: net/rfkill/ F: include/linux/rfkill.h
@@ -15285,7 +15285,7 @@ F: drivers/dma-buf/dma-fence* F: drivers/dma-buf/sw_sync.c F: include/linux/sync_file.h F: include/uapi/linux/sync_file.h -F: Documentation/sync_file.txt +F: Documentation/driver-api/sync_file.rst T: git git://anongit.freedesktop.org/drm/drm-misc SYNOPSYS ARC ARCHITECTURE
@@ -16781,7 +16781,7 @@ R: Cornelia Huck <[email protected]> L: [email protected] T: git git://github.com/awilliam/linux-vfio.git S: Maintained -F: Documentation/vfio.txt +F: Documentation/driver-api/vfio.rst F: drivers/vfio/ F: include/linux/vfio.h F: include/uapi/linux/vfio.h
@@ -16790,7 +16790,7 @@ VFIO MEDIATED DEVICE DRIVERS M: Kirti Wankhede <[email protected]> L: [email protected] S: Maintained -F: Documentation/vfio-mediated-device.txt +F: Documentation/driver-api/vfio-mediated-device.rst F: drivers/vfio/mdev/ F: include/linux/mdev.h F: samples/vfio-mdev/
Next/merge.log +2 -2
@@ -13842,7 +13842,7 @@ Merge made by the 'recursive' strategy. .../devicetree/bindings/pwm/pwm-sifive.txt | 33 ++ .../devicetree/bindings/pwm/pwm-stm32-lp.txt | 9 +- .../devicetree/bindings/pwm/pwm-stm32.txt | 3 + - Documentation/pwm.txt | 7 + + Documentation/driver-api/pwm.rst | 7 + drivers/leds/leds-pwm.c | 45 ++- drivers/pwm/Kconfig | 11 + drivers/pwm/Makefile | 1 +
@@ -14162,7 +14162,7 @@ Auto-merging drivers/ntb/hw/mscc/ntb_hw_switchtec.c Auto-merging drivers/ntb/Makefile Auto-merging drivers/ntb/Kconfig Merge made by the 'recursive' strategy. - Documentation/ntb.txt | 27 ++ + Documentation/driver-api/ntb.rst | 27 ++ drivers/ntb/Kconfig | 11 + drivers/ntb/Makefile | 3 + drivers/ntb/{ntb.c => core.c} | 0
drivers/dma-buf/Kconfig +1 -1
@@ -15,7 +15,7 @@ config SYNC_FILE associated with a buffer. When a job is submitted to the GPU a fence is attached to the buffer and is transferred via userspace, using Sync Files fds, to the DRM driver for example. More details at - Documentation/sync_file.txt. + Documentation/driver-api/sync_file.rst. config SW_SYNC bool "Sync File Validation Framework"
drivers/gpio/Kconfig +1 -1
@@ -1300,7 +1300,7 @@ config GPIO_BT8XX The card needs to be physically altered for using it as a GPIO card. For more information on how to build a GPIO card from a BT8xx TV card, see the documentation file at - Documentation/bt8xxgpio.txt + Documentation/driver-api/bt8xxgpio.rst If unsure, say N.
drivers/gpu/drm/Kconfig +1 -1
@@ -141,7 +141,7 @@ config DRM_LOAD_EDID_FIRMWARE monitor are unable to provide appropriate EDID data. Since this feature is provided as a workaround for broken hardware, the default case is N. Details and instructions how to build your own - EDID data are given in Documentation/EDID/howto.rst. + EDID data are given in Documentation/driver-api/edid.rst. config DRM_DP_CEC bool "Enable DisplayPort CEC-Tunneling-over-AUX HDMI support"
drivers/pci/switch/Kconfig +1 -1
@@ -9,7 +9,7 @@ config PCI_SW_SWITCHTEC Enables support for the management interface for the MicroSemi Switchtec series of PCIe switches. Supports userspace access to submit MRPC commands to the switch via /dev/switchtecX - devices. See <file:Documentation/switchtec.txt> for more + devices. See <file:Documentation/driver-api/switchtec.rst> for more information. endmenu
drivers/platform/x86/Kconfig +2 -2
@@ -118,7 +118,7 @@ config DCDBAS Interrupts (SMIs) and Host Control Actions (system power cycle or power off after OS shutdown) on certain Dell systems. - See <file:Documentation/dcdbas.txt> for more details on the driver + See <file:Documentation/driver-api/dcdbas.rst> for more details on the driver and the Dell systems on which Dell systems management software makes use of this driver.
@@ -259,7 +259,7 @@ config DELL_RBU DELL system. Note you need a Dell OpenManage or Dell Update package (DUP) supporting application to communicate with the BIOS regarding the new image for the image update to take effect. - See <file:Documentation/dell_rbu.txt> for more details on the driver. + See <file:Documentation/driver-api/dell_rbu.rst> for more details on the driver. config FUJITSU_LAPTOP
drivers/platform/x86/dcdbas.c +1 -1
@@ -7,7 +7,7 @@* and Host Control Actions (power cycle or power off after OS shutdown) on * Dell systems. * -* See Documentation/dcdbas.txt for more information. +* See Documentation/driver-api/dcdbas.rst for more information. * * Copyright (C) 1995-2006 Dell Inc. */
drivers/platform/x86/dell_rbu.c +1 -1
@@ -24,7 +24,7 @@* on every time the packet data is written. This driver requires an * application to break the BIOS image in to fixed sized packet chunks. * -* See Documentation/dell_rbu.txt for more info. +* See Documentation/driver-api/dell_rbu.rst for more info. */ #include <linux/init.h> #include <linux/module.h>
drivers/pnp/isapnp/Kconfig +1 -1
@@ -7,6 +7,6 @@ config ISAPNP depends on ISA || COMPILE_TEST help Say Y here if you would like support for ISA Plug and Play devices. - Some information is in <file:Documentation/isapnp.txt>. + Some information is in <file:Documentation/driver-api/isapnp.rst>. If unsure, say Y.
drivers/tty/Kconfig +1 -1
@@ -93,7 +93,7 @@ config VT_HW_CONSOLE_BINDING select the console driver that will serve as the backend for the virtual terminals. - See <file:Documentation/console/console.rst> for more + See <file:Documentation/driver-api/console.rst> for more information. For framebuffer console users, please refer to <file:Documentation/fb/fbcon.rst>.
drivers/vfio/Kconfig +1 -1
@@ -25,7 +25,7 @@ menuconfig VFIO select VFIO_IOMMU_TYPE1 if (X86 || S390 || ARM || ARM64) help VFIO provides a framework for secure userspace device drivers. - See Documentation/vfio.txt for more details. + See Documentation/driver-api/vfio.rst for more details. If you don't know what to do here, say N.
drivers/vfio/mdev/Kconfig +1 -1
@@ -6,7 +6,7 @@ config VFIO_MDEV default n help Provides a framework to virtualize devices. - See Documentation/vfio-mediated-device.txt for more details. + See Documentation/driver-api/vfio-mediated-device.rst for more details. If you don't know what do here, say N.
drivers/w1/Kconfig +1 -1
@@ -19,7 +19,7 @@ config W1_CON default y ---help--- This allows to communicate with userspace using connector. For more - information see <file:Documentation/connector/connector.rst>. + information see <file:Documentation/driver-api/connector.rst>. There are three types of messages between w1 core and userspace: 1. Events. They are generated each time new master or slave device found either due to automatic or requested search.
samples/Kconfig +1 -1
@@ -99,7 +99,7 @@ config SAMPLE_CONNECTOR When enabled, this builds both a sample kernel module for the connector interface and a user space tool to communicate with it. - See also Documentation/connector/connector.rst + See also Documentation/driver-api/connector.rst config SAMPLE_HIDRAW bool "hidraw sample"
Signature · 6 lines
2.21.0 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
PATCH 32/39 docs: serial: move it to the driver-api
In reply to Mauro Carvalho ChehabThe contents of this directory is mostly driver-api stuff.
---
Documentation/driver-api/index.rst | 1 +
Documentation/{ => driver-api}/serial/cyclades_z.rst | 0
Documentation/{ => driver-api}/serial/driver.rst | 2 +-
Documentation/{ => driver-api}/serial/index.rst | 2 +-
Documentation/{ => driver-api}/serial/moxa-smartio.rst | 0
Documentation/{ => driver-api}/serial/n_gsm.rst | 0
Documentation/{ => driver-api}/serial/rocket.rst | 0
Documentation/{ => driver-api}/serial/serial-iso7816.rst | 0
Documentation/{ => driver-api}/serial/serial-rs485.rst | 0
Documentation/{ => driver-api}/serial/tty.rst | 0
MAINTAINERS | 6 +++---
drivers/tty/Kconfig | 4 ++--
drivers/tty/serial/ucc_uart.c | 2 +-
include/linux/serial_core.h | 2 +-
14 files changed, 10 insertions(+), 9 deletions(-)
rename Documentation/{ => driver-api}/serial/cyclades_z.rst (100%)
rename Documentation/{ => driver-api}/serial/driver.rst (99%)
rename Documentation/{ => driver-api}/serial/index.rst (90%)
rename Documentation/{ => driver-api}/serial/moxa-smartio.rst (100%)
rename Documentation/{ => driver-api}/serial/n_gsm.rst (100%)
rename Documentation/{ => driver-api}/serial/rocket.rst (100%)
rename Documentation/{ => driver-api}/serial/serial-iso7816.rst (100%)
rename Documentation/{ => driver-api}/serial/serial-rs485.rst (100%)
rename Documentation/{ => driver-api}/serial/tty.rst (100%)Documentation/driver-api/index.rst +1 -0
@@ -88,6 +88,7 @@ available subsections can be seen below. pti_intel_mid pwm rfkill + serial/index sgi-ioc4 sm501 smsc_ece1099
Documentation/driver-api/serial/cyclades_z.rst renamed from Documentation/serial/cyclades_z.rst +0 -0
Documentation/driver-api/serial/driver.rst renamed from Documentation/serial/driver.rst +1 -1
@@ -311,7 +311,7 @@ hardware. This call must not sleep set_ldisc(port,termios) - Notifier for discipline change. See Documentation/serial/tty.rst. + Notifier for discipline change. See Documentation/driver-api/serial/tty.rst. Locking: caller holds tty_port->mutex
Documentation/driver-api/serial/index.rst renamed from Documentation/serial/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ========================== Support for Serial devices
Documentation/driver-api/serial/moxa-smartio.rst renamed from Documentation/serial/moxa-smartio.rst +0 -0
Documentation/driver-api/serial/n_gsm.rst renamed from Documentation/serial/n_gsm.rst +0 -0
Documentation/driver-api/serial/rocket.rst renamed from Documentation/serial/rocket.rst +0 -0
Documentation/driver-api/serial/serial-iso7816.rst renamed from Documentation/serial/serial-iso7816.rst +0 -0
Documentation/driver-api/serial/serial-rs485.rst renamed from Documentation/serial/serial-rs485.rst +0 -0
Documentation/driver-api/serial/tty.rst renamed from Documentation/serial/tty.rst +0 -0
MAINTAINERS +3 -3
@@ -10723,7 +10723,7 @@ F: include/uapi/linux/meye.h MOXA SMARTIO/INDUSTIO/INTELLIO SERIAL CARD M: Jiri Slaby <[email protected]> S: Maintained -F: Documentation/serial/moxa-smartio.rst +F: Documentation/driver-api/serial/moxa-smartio.rst F: drivers/tty/mxser.* MR800 AVERMEDIA USB FM RADIO DRIVER
@@ -13637,7 +13637,7 @@ ROCKETPORT DRIVER P: Comtrol Corp. W: http://www.comtrol.com S: Maintained -F: Documentation/serial/rocket.rst +F: Documentation/driver-api/serial/rocket.rst F: drivers/tty/rocket* ROCKETPORT EXPRESS/INFINITY DRIVER
@@ -16170,7 +16170,7 @@ M: Greg Kroah-Hartman <[email protected]> M: Jiri Slaby <[email protected]> S: Supported T: git git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/tty.git -F: Documentation/serial/ +F: Documentation/driver-api/serial/ F: drivers/tty/ F: drivers/tty/serial/serial_core.c F: include/linux/serial_core.h
drivers/tty/Kconfig +2 -2
@@ -175,7 +175,7 @@ config ROCKETPORT This driver supports Comtrol RocketPort and RocketModem PCI boards. These boards provide 2, 4, 8, 16, or 32 high-speed serial ports or modems. For information about the RocketPort/RocketModem boards - and this driver read <file:Documentation/serial/rocket.rst>. + and this driver read <file:Documentation/driver-api/serial/rocket.rst>. To compile this driver as a module, choose M here: the module will be called rocket.
@@ -193,7 +193,7 @@ config CYCLADES your Linux box, for instance in order to become a dial-in server. For information about the Cyclades-Z card, read - <file:Documentation/serial/cyclades_z.rst>. + <file:Documentation/driver-api/serial/cyclades_z.rst>. To compile this driver as a module, choose M here: the module will be called cyclades.
drivers/tty/serial/ucc_uart.c +1 -1
@@ -1081,7 +1081,7 @@ static int qe_uart_verify_port(struct uart_port *port, }/* UART operations * -* Details on these functions can be found in Documentation/serial/driver.rst +* Details on these functions can be found in Documentation/driver-api/serial/driver.rst */ static const struct uart_ops qe_uart_pops = { .tx_empty = qe_uart_tx_empty,
include/linux/serial_core.h +1 -1
@@ -32,7 +32,7 @@ struct device;/* * This structure describes all the operations that can be done on the -* physical hardware. See Documentation/serial/driver.rst for details. +* physical hardware. See Documentation/driver-api/serial/driver.rst for details. */ struct uart_ops {unsigned int (*tx_empty)(struct uart_port *);
Signature · 1 line
2.21.0
PATCH 33/39 docs: phy: place documentation under driver-api
In reply to Mauro Carvalho ChehabThis subsystem-specific documentation belongs to the driver-api.
---
.../devicetree/bindings/phy/phy-bindings.txt | 2 +-
.../devicetree/bindings/phy/phy-pxa-usb.txt | 2 +-
Documentation/driver-api/index.rst | 1 +
Documentation/driver-api/phy/index.rst | 16 ++++++++++++++++
.../{phy.txt => driver-api/phy/phy.rst} | 0
.../{ => driver-api}/phy/samsung-usb2.rst | 0
Documentation/index.rst | 1 -
MAINTAINERS | 2 +-
8 files changed, 20 insertions(+), 4 deletions(-)
create mode 100644 Documentation/driver-api/phy/index.rst
rename Documentation/{phy.txt => driver-api/phy/phy.rst} (100%)
rename Documentation/{ => driver-api}/phy/samsung-usb2.rst (100%)Documentation/devicetree/bindings/phy/phy-bindings.txt +1 -1
@@ -1,5 +1,5 @@ This document explains only the device tree data binding. For general -information about PHY subsystem refer to Documentation/phy.txt +information about PHY subsystem refer to Documentation/driver-api/phy/phy.rst PHY device node ===============
Documentation/devicetree/bindings/phy/phy-pxa-usb.txt +1 -1
@@ -15,4 +15,4 @@ Example: }; This document explains the device tree binding. For general -information about PHY subsystem refer to Documentation/phy.txt +information about PHY subsystem refer to Documentation/driver-api/phy/phy.rst
Documentation/driver-api/index.rst +1 -0
@@ -85,6 +85,7 @@ available subsections can be seen below. parport-lowlevel pps ptp + phy/index pti_intel_mid pwm rfkill
Documentation/driver-api/phy/index.rst new file +16 -0
@@ -0,0 +1,16 @@ +===================== +Generic PHY Framework +===================== + +.. toctree:: + + phy + samsung-usb2 + +.. only:: subproject and html + + Indices + ======= + + * :ref:`genindex` +
Documentation/driver-api/phy/phy.rst renamed from Documentation/phy.txt +0 -0
Documentation/driver-api/phy/samsung-usb2.rst renamed from Documentation/phy/samsung-usb2.rst +0 -0
Documentation/index.rst +0 -1
@@ -112,7 +112,6 @@ needed). usb/index misc-devices/index mic/index - phy/samsung-usb2 scheduler/index Architecture-specific documentation
MAINTAINERS +1 -1
@@ -14031,7 +14031,7 @@ M: Sylwester Nawrocki <[email protected]> L: [email protected] S: Supported F: Documentation/devicetree/bindings/phy/samsung-phy.txt -F: Documentation/phy/samsung-usb2.rst +F: Documentation/driver-api/phy/samsung-usb2.rst F: drivers/phy/samsung/phy-exynos4210-usb2.c F: drivers/phy/samsung/phy-exynos4x12-usb2.c F: drivers/phy/samsung/phy-exynos5250-usb2.c
Signature · 1 line
2.21.0
PATCH 35/39 docs: infiniband: add it to the driver-api bookset
In reply to Mauro Carvalho ChehabWhile this contains some uAPI stuff, it was intended to be read by a kernel doc. So, let's not move it to a different dir, but, instead, just add it to the driver-api bookset.
--- Documentation/index.rst | 1 + Documentation/infiniband/index.rst | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-)
Documentation/index.rst +1 -0
@@ -96,6 +96,7 @@ needed). block/index hid/index iio/index + infiniband/index leds/index media/index networking/index
Documentation/infiniband/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ========== InfiniBand
Signature · 1 line
2.21.0
PATCH 36/39 docs: add SPDX tags to new index files
In reply to Mauro Carvalho ChehabAll those new files I added are under GPL v2.0 license.
Add the corresponding SPDX headers to them.
--- Documentation/admin-guide/blockdev/drbd/figures.rst | 2 ++ Documentation/admin-guide/blockdev/index.rst | 2 ++ Documentation/admin-guide/laptops/index.rst | 1 + Documentation/admin-guide/namespaces/index.rst | 2 ++ Documentation/admin-guide/perf/index.rst | 2 ++ Documentation/arm/index.rst | 2 ++ Documentation/arm/nwfpe/index.rst | 2 ++ Documentation/arm/omap/index.rst | 2 ++ Documentation/arm/sa1100/index.rst | 2 ++ Documentation/arm/samsung-s3c24xx/index.rst | 2 ++ Documentation/arm/samsung/index.rst | 2 ++ Documentation/driver-api/early-userspace/index.rst | 2 ++ Documentation/driver-api/md/index.rst | 2 ++ Documentation/driver-api/memory-devices/index.rst | 2 ++ Documentation/driver-api/mmc/index.rst | 2 ++ Documentation/driver-api/mtd/index.rst | 2 ++ Documentation/driver-api/nfc/index.rst | 2 ++ Documentation/driver-api/nvdimm/index.rst | 2 ++ Documentation/driver-api/phy/index.rst | 2 ++ Documentation/driver-api/rapidio/index.rst | 2 ++ Documentation/driver-api/thermal/index.rst | 2 ++ Documentation/ia64/index.rst | 2 ++ 22 files changed, 43 insertions(+)
Documentation/admin-guide/blockdev/drbd/figures.rst +2 -0
@@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: GPL-2.0 + .. The here included files are intended to help understand the implementation Data flows that Relate some functions, and write packets
Documentation/admin-guide/blockdev/index.rst +2 -0
@@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: GPL-2.0 + =========================== The Linux RapidIO Subsystem ===========================
Documentation/admin-guide/laptops/index.rst +1 -0
@@ -1,3 +1,4 @@ +.. SPDX-License-Identifier: GPL-2.0 ============== Laptop Drivers
Documentation/admin-guide/namespaces/index.rst +2 -0
@@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: GPL-2.0 + ========== Namespaces ==========
Documentation/admin-guide/perf/index.rst +2 -0
@@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: GPL-2.0 + =========================== Performance monitor support ===========================
Documentation/arm/index.rst +2 -0
@@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: GPL-2.0 + ================ ARM Architecture ================
Documentation/arm/nwfpe/index.rst +2 -0
@@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: GPL-2.0 + =================================== NetWinder's floating point emulator ===================================
Documentation/arm/omap/index.rst +2 -0
@@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: GPL-2.0 + ======= TI OMAP =======
Documentation/arm/sa1100/index.rst +2 -0
@@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: GPL-2.0 + ==================== Intel StrongARM 1100 ====================
Documentation/arm/samsung-s3c24xx/index.rst +2 -0
@@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: GPL-2.0 + ========================== Samsung S3C24XX SoC Family ==========================
Documentation/arm/samsung/index.rst +2 -0
@@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: GPL-2.0 + =========== Samsung SoC ===========
Documentation/driver-api/early-userspace/index.rst +2 -0
@@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: GPL-2.0 + =============== Early Userspace ===============
Documentation/driver-api/md/index.rst +2 -0
@@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: GPL-2.0 + ==== RAID ====
Documentation/driver-api/memory-devices/index.rst +2 -0
@@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: GPL-2.0 + ========================= Memory Controller drivers =========================
Documentation/driver-api/mmc/index.rst +2 -0
@@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: GPL-2.0 + ======================== MMC/SD/SDIO card support ========================
Documentation/driver-api/mtd/index.rst +2 -0
@@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: GPL-2.0 + ============================== Memory Technology Device (MTD) ==============================
Documentation/driver-api/nfc/index.rst +2 -0
@@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: GPL-2.0 + ======================== Near Field Communication ========================
Documentation/driver-api/nvdimm/index.rst +2 -0
@@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: GPL-2.0 + =================================== Non-Volatile Memory Device (NVDIMM) ===================================
Documentation/driver-api/phy/index.rst +2 -0
@@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: GPL-2.0 + ===================== Generic PHY Framework =====================
Documentation/driver-api/rapidio/index.rst +2 -0
@@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: GPL-2.0 + =========================== The Linux RapidIO Subsystem ===========================
Documentation/driver-api/thermal/index.rst +2 -0
@@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: GPL-2.0 + ======= Thermal =======
Documentation/ia64/index.rst +2 -0
@@ -1,3 +1,5 @@ +.. SPDX-License-Identifier: GPL-2.0 + ================== IA-64 Architecture ==================
Signature · 1 line
2.21.0
PATCH 37/39 docs: adds some directories to the main documentation index
In reply to Mauro Carvalho ChehabThe contents of those directories were orphaned at the documentation body.
While those directories could likely be moved to be inside some guide, I'm opting to just adding their indexes to the main one, removing the :orphan: and adding the SPDX header.
For the drivers, the rationale is that the documentation contains a mix of Kernelspace, uAPI and admin-guide. So, better to keep them on separate directories, as we've be doing with similar subsystem-specific docs that were not split yet.
For the others, well... I'm too lazy to do the move. Also, it seems to make sense to keep at least some of those at the main dir (like kbuild, for example). In any case, a latter patch could do the move.
--- Documentation/cdrom/index.rst | 2 +- Documentation/fault-injection/index.rst | 2 +- Documentation/fb/index.rst | 2 +- Documentation/fpga/index.rst | 2 +- Documentation/ide/index.rst | 2 +- Documentation/index.rst | 14 ++++++++++++++ Documentation/kbuild/index.rst | 2 +- Documentation/livepatch/index.rst | 2 +- Documentation/netlabel/index.rst | 2 +- Documentation/pcmcia/index.rst | 2 +- Documentation/power/index.rst | 2 +- Documentation/target/index.rst | 2 +- Documentation/timers/index.rst | 2 +- Documentation/watchdog/index.rst | 2 +- 14 files changed, 27 insertions(+), 13 deletions(-)
Documentation/cdrom/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 == cdrom
Documentation/fault-injection/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ======= fault-injection
Documentation/fb/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ====== Frame Buffer
Documentation/fpga/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 == fpga
Documentation/ide/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ================= Integrated Drive Electronics (IDE)
Documentation/index.rst +14 -0
@@ -35,6 +35,7 @@ trying to get it to work optimally on a given system. :maxdepth: 2 admin-guide/index + kbuild/index Firmware-related documentation ------------------------------
@@ -77,6 +78,9 @@ merged much easier. kernel-hacking/index trace/index maintainer/index + fault-injection/index + livepatch/index + Kernel API documentation ------------------------
@@ -94,12 +98,22 @@ needed). core-api/index accounting/index block/index + cdrom/index + ide/index + fb/index + fpga/index hid/index iio/index infiniband/index leds/index media/index + netlabel/index networking/index + pcmcia/index + power/index + target/index + timers/index + watchdog/index input/index hwmon/index gpu/index
Documentation/kbuild/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ========= Kernel Build System
Documentation/livepatch/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ========= Kernel Livepatching
Documentation/netlabel/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ==== NetLabel
Documentation/pcmcia/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 === pcmcia
Documentation/power/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ======== Power Management
Documentation/target/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ========= TCM Virtual Device
Documentation/timers/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 === timers
Documentation/watchdog/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 =========== Linux Watchdog Support
Signature · 1 line
2.21.0
PATCH 10/39 docs: leds: add it to the driver-api book
In reply to Mauro Carvalho ChehabThe 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.
--- Documentation/index.rst | 1 + Documentation/leds/index.rst | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-)
Documentation/index.rst +1 -0
@@ -91,6 +91,7 @@ needed). driver-api/index core-api/index + leds/index media/index networking/index input/index
Documentation/leds/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ==== LEDs
Signature · 1 line
2.21.0
PATCH 4/39 docs: nvdimm: add it to the driver-api book
In reply to Mauro Carvalho ChehabThe descriptions here are from Kernel driver's PoV.
---
Documentation/driver-api/index.rst | 1 +
Documentation/{ => driver-api}/nvdimm/btt.rst | 0
Documentation/{ => driver-api}/nvdimm/index.rst | 2 --
Documentation/{ => driver-api}/nvdimm/nvdimm.rst | 0
Documentation/{ => driver-api}/nvdimm/security.rst | 0
drivers/nvdimm/Kconfig | 2 +-
6 files changed, 2 insertions(+), 3 deletions(-)
rename Documentation/{ => driver-api}/nvdimm/btt.rst (100%)
rename Documentation/{ => driver-api}/nvdimm/index.rst (94%)
rename Documentation/{ => driver-api}/nvdimm/nvdimm.rst (100%)
rename Documentation/{ => driver-api}/nvdimm/security.rst (100%)Documentation/driver-api/index.rst +1 -0
@@ -43,6 +43,7 @@ available subsections can be seen below. mtdnand miscellaneous mei/index + nvdimm/index w1 rapidio/index s390-drivers
Documentation/driver-api/nvdimm/btt.rst renamed from Documentation/nvdimm/btt.rst +0 -0
Documentation/driver-api/nvdimm/index.rst renamed from Documentation/nvdimm/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =================================== Non-Volatile Memory Device (NVDIMM) ===================================
Documentation/driver-api/nvdimm/nvdimm.rst renamed from Documentation/nvdimm/nvdimm.rst +0 -0
Documentation/driver-api/nvdimm/security.rst renamed from Documentation/nvdimm/security.rst +0 -0
drivers/nvdimm/Kconfig +1 -1
@@ -33,7 +33,7 @@ config BLK_DEV_PMEM Documentation/admin-guide/kernel-parameters.rst). This driver converts these persistent memory ranges into block devices that are capable of DAX (direct-access) file system mappings. See - Documentation/nvdimm/nvdimm.rst for more details. + Documentation/driver-api/nvdimm/nvdimm.rst for more details. Say Y if you want to use an NVDIMM
Signature · 6 lines
2.21.0 _______________________________________________ Linux-nvdimm mailing list [email protected] https://lists.01.org/mailman/listinfo/linux-nvdimm
PATCH 34/39 docs: add a memory-devices subdir to driver-api
In reply to Mauro Carvalho ChehabThere are two docs describing memory device drivers.
Add both to this new chapter of the driver-api.
---
Documentation/driver-api/index.rst | 1 +
.../driver-api/memory-devices/index.rst | 16 ++++++++++++++++
.../{ => driver-api}/memory-devices/ti-emif.rst | 2 +-
.../memory-devices}/ti-gpmc.rst | 2 +-
4 files changed, 19 insertions(+), 2 deletions(-)
create mode 100644 Documentation/driver-api/memory-devices/index.rst
rename Documentation/{ => driver-api}/memory-devices/ti-emif.rst (98%)
rename Documentation/{bus-devices => driver-api/memory-devices}/ti-gpmc.rst (99%)Documentation/driver-api/index.rst +1 -0
@@ -79,6 +79,7 @@ available subsections can be seen below. isapnp generic-counter lightnvm-pblk + memory-devices/index men-chameleon-bus ntb nvmem
Documentation/driver-api/memory-devices/index.rst new file +16 -0
@@ -0,0 +1,16 @@ +========================= +Memory Controller drivers +========================= + +.. toctree:: + :maxdepth: 1 + + ti-emif + ti-gpmc + +.. only:: subproject and html + + Indices + ======= + + * :ref:`genindex`
Documentation/driver-api/memory-devices/ti-emif.rst renamed from Documentation/memory-devices/ti-emif.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 =============================== TI EMIF SDRAM Controller Driver
Documentation/driver-api/memory-devices/ti-gpmc.rst renamed from Documentation/bus-devices/ti-gpmc.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ======================================== GPMC (General Purpose Memory Controller)
Signature · 1 line
2.21.0
PATCH 13/39 docs: add arch doc directories to the index
In reply to Mauro Carvalho ChehabNow that several arch documents were converted to ReST, add their indexes to Documentation/index.rst and remove the :orphan: from them.
--- Documentation/arm/index.rst | 2 -- Documentation/arm64/index.rst | 2 -- Documentation/ia64/index.rst | 2 -- Documentation/index.rst | 10 ++++++++++ Documentation/m68k/index.rst | 2 +- Documentation/powerpc/index.rst | 2 +- Documentation/riscv/index.rst | 2 -- Documentation/s390/index.rst | 2 -- Documentation/sparc/index.rst | 2 -- Documentation/xtensa/index.rst | 2 +- 10 files changed, 13 insertions(+), 15 deletions(-)
Documentation/arm/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================ ARM Architecture ================
Documentation/arm64/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================== ARM64 Architecture ==================
Documentation/ia64/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================== IA-64 Architecture ==================
Documentation/index.rst +10 -0
@@ -118,7 +118,17 @@ implementation. :maxdepth: 2 sh/index + arm/index + arm64/index + ia64/index + m68k/index + powerpc/index + riscv/index + s390/index + sh/index + sparc/index x86/index + xtensa/index Filesystem Documentation ------------------------
Documentation/m68k/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ================= m68k Architecture
Documentation/powerpc/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ======= powerpc
Documentation/riscv/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =================== RISC-V architecture ===================
Documentation/s390/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================= s390 Architecture =================
Documentation/sparc/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================== Sparc Architecture ==================
Documentation/xtensa/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 =================== Xtensa Architecture
Signature · 1 line
2.21.0
PATCH 22/39 docs: ocxl.rst: add it to the uAPI book
In reply to Mauro Carvalho ChehabThe content of this file is user-faced.
---
Documentation/{ => userspace-api}/accelerators/ocxl.rst | 2 --
Documentation/userspace-api/index.rst | 1 +
MAINTAINERS | 2 +-
3 files changed, 2 insertions(+), 3 deletions(-)
rename Documentation/{ => userspace-api}/accelerators/ocxl.rst (99%)Documentation/userspace-api/accelerators/ocxl.rst renamed from Documentation/accelerators/ocxl.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ======================================================== OpenCAPI (Open Coherent Accelerator Processor Interface) ========================================================
Documentation/userspace-api/index.rst +1 -0
@@ -20,6 +20,7 @@ place where this information is gathered. seccomp_filter unshare spec_ctrl + accelerators/ocxl .. only:: subproject and html
MAINTAINERS +1 -1
@@ -11483,7 +11483,7 @@ F: arch/powerpc/include/asm/pnv-ocxl.h F: drivers/misc/ocxl/ F: include/misc/ocxl* F: include/uapi/misc/ocxl.h -F: Documentation/accelerators/ocxl.rst +F: Documentation/userspace-api/accelerators/ocxl.rst OMAP AUDIO SUPPORT M: Peter Ujfalusi <[email protected]>
Signature · 1 line
2.21.0
PATCH 30/39 docs: driver-api: add xilinx driver API documentation
In reply to Mauro Carvalho ChehabThe current file there (emmi) provides a description of the driver uAPI and kAPI.
---
Documentation/driver-api/index.rst | 1 +
Documentation/{ => driver-api}/xilinx/eemi.rst | 0
Documentation/{ => driver-api}/xilinx/index.rst | 1 -
3 files changed, 1 insertion(+), 1 deletion(-)
rename Documentation/{ => driver-api}/xilinx/eemi.rst (100%)
rename Documentation/{ => driver-api}/xilinx/index.rst (94%)Documentation/driver-api/index.rst +1 -0
@@ -93,6 +93,7 @@ available subsections can be seen below. sync_file vfio-mediated-device vfio + xilinx/index xillybus zorro
Documentation/driver-api/xilinx/eemi.rst renamed from Documentation/xilinx/eemi.rst +0 -0
Documentation/driver-api/xilinx/index.rst renamed from Documentation/xilinx/index.rst +0 -1
@@ -1,4 +1,3 @@ -:orphan: =========== Xilinx FPGA
Signature · 1 line
2.21.0
PATCH 39/39 docs: gpio: add sysfs interface to the admin-guide
In reply to Mauro Carvalho ChehabWhile this is stated as obsoleted, the sysfs interface described there is still valid, and belongs to the admin-guide.
---
Documentation/ABI/obsolete/sysfs-gpio | 2 +-
Documentation/{ => admin-guide}/gpio/index.rst | 2 +-
Documentation/{ => admin-guide}/gpio/sysfs.rst | 0
Documentation/admin-guide/index.rst | 1 +
Documentation/firmware-guide/acpi/enumeration.rst | 2 +-
Documentation/translations/zh_CN/gpio.txt | 4 ++--
MAINTAINERS | 2 +-
7 files changed, 7 insertions(+), 6 deletions(-)
rename Documentation/{ => admin-guide}/gpio/index.rst (78%)
rename Documentation/{ => admin-guide}/gpio/sysfs.rst (100%)Documentation/ABI/obsolete/sysfs-gpio +1 -1
@@ -11,7 +11,7 @@ Description: Kernel code may export it for complete or partial access. GPIOs are identified as they are inside the kernel, using integers in - the range 0..INT_MAX. See Documentation/gpio for more information. + the range 0..INT_MAX. See Documentation/admin-guide/gpio for more information. /sys/class/gpio /export ... asks the kernel to export a GPIO to userspace
Documentation/admin-guide/gpio/index.rst renamed from Documentation/gpio/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ==== gpio
Documentation/admin-guide/gpio/sysfs.rst renamed from Documentation/gpio/sysfs.rst +0 -0
Documentation/admin-guide/index.rst +1 -0
@@ -90,6 +90,7 @@ configure specific aspects of kernel behavior to your liking. cputopology device-mapper/index efi-stub + gpio/index highuid hw_random iostats
Documentation/firmware-guide/acpi/enumeration.rst +1 -1
@@ -316,7 +316,7 @@ specifies the path to the controller. In order to use these GPIOs in Linux we need to translate them to the corresponding Linux GPIO descriptors. There is a standard GPIO API for that and is documented in -Documentation/gpio/. +Documentation/admin-guide/gpio/. In the above example we can get the corresponding two GPIO descriptors with a code like this::
Documentation/translations/zh_CN/gpio.txt +2 -2
@@ -1,4 +1,4 @@ -Chinese translated version of Documentation/gpio +Chinese translated version of Documentation/admin-guide/gpio If you have any comment or update to the content, please contact the original document maintainer directly. However, if you have a problem
@@ -10,7 +10,7 @@ Maintainer: Grant Likely <[email protected]> Linus Walleij <[email protected]> Chinese maintainer: Fu Wei <[email protected]> --------------------------------------------------------------------- -Documentation/gpio 的中文翻译 +Documentation/admin-guide/gpio 的中文翻译 如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文 交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻
MAINTAINERS +1 -1
@@ -6812,7 +6812,7 @@ T: git git://git.kernel.org/pub/scm/linux/kernel/git/linusw/linux-gpio.git S: Maintained F: Documentation/devicetree/bindings/gpio/ F: Documentation/driver-api/gpio/ -F: Documentation/gpio/ +F: Documentation/admin-guide/gpio/ F: Documentation/ABI/testing/gpio-cdev F: Documentation/ABI/obsolete/sysfs-gpio F: drivers/gpio/
Signature · 1 line
2.21.0
PATCH 6/39 docs: mtd: move it to the driver-api book
In reply to Mauro Carvalho ChehabWhile I was tempted to move it to admin-guide, as some docs there are more userspace-faced, there are some very technical discussions about memory error correction code from the Kernel implementer's PoV. So, let's place it inside the driver-api book.
---
Documentation/driver-api/index.rst | 1 +
Documentation/{ => driver-api}/mtd/index.rst | 2 --
Documentation/{ => driver-api}/mtd/intel-spi.rst | 0
Documentation/{ => driver-api}/mtd/nand_ecc.rst | 0
Documentation/{ => driver-api}/mtd/spi-nor.rst | 0
drivers/mtd/nand/raw/nand_ecc.c | 2 +-
6 files changed, 2 insertions(+), 3 deletions(-)
rename Documentation/{ => driver-api}/mtd/index.rst (94%)
rename Documentation/{ => driver-api}/mtd/intel-spi.rst (100%)
rename Documentation/{ => driver-api}/mtd/nand_ecc.rst (100%)
rename Documentation/{ => driver-api}/mtd/spi-nor.rst (100%)Documentation/driver-api/index.rst +1 -0
@@ -43,6 +43,7 @@ available subsections can be seen below. mtdnand miscellaneous mei/index + mtd/index nvdimm/index w1 rapidio/index
Documentation/driver-api/mtd/index.rst renamed from Documentation/mtd/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============================== Memory Technology Device (MTD) ==============================
Documentation/driver-api/mtd/intel-spi.rst renamed from Documentation/mtd/intel-spi.rst +0 -0
Documentation/driver-api/mtd/nand_ecc.rst renamed from Documentation/mtd/nand_ecc.rst +0 -0
Documentation/driver-api/mtd/spi-nor.rst renamed from Documentation/mtd/spi-nor.rst +0 -0
drivers/mtd/nand/raw/nand_ecc.c +1 -1
@@ -11,7 +11,7 @@* Thomas Gleixner ([email protected]) * * Information on how this algorithm works and how it was developed -* can be found in Documentation/mtd/nand_ecc.rst +* can be found in Documentation/driver-api/mtd/nand_ecc.rst */ #include <linux/types.h>
Signature · 6 lines
2.21.0 ______________________________________________________ Linux MTD discussion mailing list http://lists.infradead.org/mailman/listinfo/linux-mtd/
PATCH 26/39 docs: aoe: add it to the driver-api book
In reply to Mauro Carvalho ChehabThose files belong to the admin guide, so add them.
---
Documentation/{ => admin-guide}/aoe/aoe.rst | 4 ++--
Documentation/{ => admin-guide}/aoe/autoload.sh | 0
Documentation/{ => admin-guide}/aoe/examples.rst | 0
Documentation/{ => admin-guide}/aoe/index.rst | 2 --
Documentation/{ => admin-guide}/aoe/status.sh | 0
Documentation/{ => admin-guide}/aoe/todo.rst | 0
Documentation/{ => admin-guide}/aoe/udev-install.sh | 0
Documentation/{ => admin-guide}/aoe/udev.txt | 2 +-
Documentation/admin-guide/index.rst | 1 +
MAINTAINERS | 2 +-
10 files changed, 5 insertions(+), 6 deletions(-)
rename Documentation/{ => admin-guide}/aoe/aoe.rst (97%)
rename Documentation/{ => admin-guide}/aoe/autoload.sh (100%)
rename Documentation/{ => admin-guide}/aoe/examples.rst (100%)
rename Documentation/{ => admin-guide}/aoe/index.rst (95%)
rename Documentation/{ => admin-guide}/aoe/status.sh (100%)
rename Documentation/{ => admin-guide}/aoe/todo.rst (100%)
rename Documentation/{ => admin-guide}/aoe/udev-install.sh (100%)
rename Documentation/{ => admin-guide}/aoe/udev.txt (93%)Documentation/admin-guide/aoe/aoe.rst renamed from Documentation/aoe/aoe.rst +2 -2
@@ -20,7 +20,7 @@ driver. The aoetools are on sourceforge. http://aoetools.sourceforge.net/ -The scripts in this Documentation/aoe directory are intended to +The scripts in this Documentation/admin-guide/aoe directory are intended to document the use of the driver and are not necessary if you install the aoetools.
@@ -86,7 +86,7 @@ Using sysfs a convenient way. Users with aoetools should use the aoe-stat command:: - root@makki root# sh Documentation/aoe/status.sh + root@makki root# sh Documentation/admin-guide/aoe/status.sh e10.0 eth3 up e10.1 eth3 up e10.2 eth3 up
Documentation/admin-guide/aoe/autoload.sh renamed from Documentation/aoe/autoload.sh +0 -0
Documentation/admin-guide/aoe/examples.rst renamed from Documentation/aoe/examples.rst +0 -0
Documentation/admin-guide/aoe/index.rst renamed from Documentation/aoe/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ======================= ATA over Ethernet (AoE) =======================
Documentation/admin-guide/aoe/status.sh renamed from Documentation/aoe/status.sh +0 -0
Documentation/admin-guide/aoe/todo.rst renamed from Documentation/aoe/todo.rst +0 -0
Documentation/admin-guide/aoe/udev-install.sh renamed from Documentation/aoe/udev-install.sh +0 -0
Documentation/admin-guide/aoe/udev.txt renamed from Documentation/aoe/udev.txt +1 -1
@@ -11,7 +11,7 @@ # udev_rules="/etc/udev/rules.d/" # bash# ls /etc/udev/rules.d/ # 10-wacom.rules 50-udev.rules -# bash# cp /path/to/linux/Documentation/aoe/udev.txt \ +# bash# cp /path/to/linux/Documentation/admin-guide/aoe/udev.txt \ # /etc/udev/rules.d/60-aoe.rules #
Documentation/admin-guide/index.rst +1 -0
@@ -82,6 +82,7 @@ configure specific aspects of kernel behavior to your liking. namespaces/index perf-security acpi/index + aoe/index device-mapper/index laptops/index
MAINTAINERS +1 -1
@@ -2650,7 +2650,7 @@ ATA OVER ETHERNET (AOE) DRIVER M: "Justin Sanders" <[email protected]> W: http://www.openaoe.org/ S: Supported -F: Documentation/aoe/ +F: Documentation/admin-guide/aoe/ F: drivers/block/aoe/ ATHEROS 71XX/9XXX GPIO DRIVER
Signature · 1 line
2.21.0
PATCH 3/39 docs: perf: move to the admin-guide
In reply to Mauro Carvalho ChehabThe perf infrastructure is used for userspace to track issues. At least a good part of what's described here is related to it.
So, add it to the admin-guide.
---
Documentation/admin-guide/index.rst | 1 +
Documentation/{ => admin-guide}/perf/arm-ccn.rst | 0
Documentation/{ => admin-guide}/perf/arm_dsu_pmu.rst | 0
Documentation/{ => admin-guide}/perf/hisi-pmu.rst | 0
Documentation/{ => admin-guide}/perf/index.rst | 2 --
Documentation/{ => admin-guide}/perf/qcom_l2_pmu.rst | 0
Documentation/{ => admin-guide}/perf/qcom_l3_pmu.rst | 0
Documentation/{ => admin-guide}/perf/thunderx2-pmu.rst | 0
Documentation/{ => admin-guide}/perf/xgene-pmu.rst | 0
MAINTAINERS | 4 ++--
drivers/perf/qcom_l3_pmu.c | 2 +-
11 files changed, 4 insertions(+), 5 deletions(-)
rename Documentation/{ => admin-guide}/perf/arm-ccn.rst (100%)
rename Documentation/{ => admin-guide}/perf/arm_dsu_pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/hisi-pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/index.rst (95%)
rename Documentation/{ => admin-guide}/perf/qcom_l2_pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/qcom_l3_pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/thunderx2-pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/xgene-pmu.rst (100%)Documentation/admin-guide/index.rst +1 -0
@@ -38,6 +38,7 @@ problems and bugs in particular. ramoops dynamic-debug-howto init + perf/index This is the beginning of a section with information of interest to application developers. Documents covering various aspects of the kernel
Documentation/admin-guide/perf/arm-ccn.rst renamed from Documentation/perf/arm-ccn.rst +0 -0
Documentation/admin-guide/perf/arm_dsu_pmu.rst renamed from Documentation/perf/arm_dsu_pmu.rst +0 -0
Documentation/admin-guide/perf/hisi-pmu.rst renamed from Documentation/perf/hisi-pmu.rst +0 -0
Documentation/admin-guide/perf/index.rst renamed from Documentation/perf/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =========================== Performance monitor support ===========================
Documentation/admin-guide/perf/qcom_l2_pmu.rst renamed from Documentation/perf/qcom_l2_pmu.rst +0 -0
Documentation/admin-guide/perf/qcom_l3_pmu.rst renamed from Documentation/perf/qcom_l3_pmu.rst +0 -0
Documentation/admin-guide/perf/thunderx2-pmu.rst renamed from Documentation/perf/thunderx2-pmu.rst +0 -0
Documentation/admin-guide/perf/xgene-pmu.rst renamed from Documentation/perf/xgene-pmu.rst +0 -0
MAINTAINERS +2 -2
@@ -1139,7 +1139,7 @@ APPLIED MICRO (APM) X-GENE SOC PMU M: Khuong Dinh <[email protected]> S: Supported F: drivers/perf/xgene_pmu.c -F: Documentation/perf/xgene-pmu.rst +F: Documentation/admin-guide/perf/xgene-pmu.rst F: Documentation/devicetree/bindings/perf/apm-xgene-pmu.txt APTINA CAMERA SENSOR PLL
@@ -7207,7 +7207,7 @@ M: Shaokun Zhang <[email protected]> W: http://www.hisilicon.com S: Supported F: drivers/perf/hisilicon -F: Documentation/perf/hisi-pmu.rst +F: Documentation/admin-guide/perf/hisi-pmu.rst HISILICON ROCE DRIVER M: Lijun Ou <[email protected]>
drivers/perf/qcom_l3_pmu.c +1 -1
@@ -8,7 +8,7 @@* the slices. User space needs to aggregate to individual counts to provide * a global picture. * -* See Documentation/perf/qcom_l3_pmu.rst for more details. +* See Documentation/admin-guide/perf/qcom_l3_pmu.rst for more details. * * Copyright (c) 2015-2017, The Linux Foundation. All rights reserved. */
Signature · 7 lines
2.21.0 _______________________________________________ linux-arm-kernel mailing list [email protected] http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
PATCH 20/39 docs: security: move some books to it and update
In reply to Mauro Carvalho ChehabThe following files belong to security:
Documentation/security/LSM.rst -> Documentation/security/lsm-development.rst Documentation/lsm.txt -> Documentation/security/lsm.rst Documentation/SAK.txt -> Documentation/security/sak.rst Documentation/siphash.txt -> Documentation/security/siphash.rst
---
Documentation/security/index.rst | 5 ++++-
Documentation/security/{LSM.rst => lsm-development.rst} | 0
Documentation/{lsm.txt => security/lsm.rst} | 0
Documentation/{SAK.txt => security/sak.rst} | 0
Documentation/{siphash.txt => security/siphash.rst} | 0
Documentation/security/tpm/index.rst | 1 +
Documentation/security/tpm/xen-tpmfront.rst | 2 --
7 files changed, 5 insertions(+), 3 deletions(-)
rename Documentation/security/{LSM.rst => lsm-development.rst} (100%)
rename Documentation/{lsm.txt => security/lsm.rst} (100%)
rename Documentation/{SAK.txt => security/sak.rst} (100%)
rename Documentation/{siphash.txt => security/siphash.rst} (100%)Documentation/security/index.rst +4 -1
@@ -8,7 +8,10 @@ Security Documentation credentials IMA-templates keys/index - LSM + lsm + lsm-development + sak SCTP self-protection + siphash tpm/index
Documentation/security/lsm-development.rst renamed from Documentation/security/LSM.rst +0 -0
Documentation/security/lsm.rst renamed from Documentation/lsm.txt +0 -0
Documentation/security/sak.rst renamed from Documentation/SAK.txt +0 -0
Documentation/security/siphash.rst renamed from Documentation/siphash.txt +0 -0
Documentation/security/tpm/index.rst +1 -0
@@ -5,3 +5,4 @@ Trusted Platform Module documentation .. toctree:: tpm_vtpm_proxy + xen-tpmfront
Documentation/security/tpm/xen-tpmfront.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============================= Virtual TPM interface for Xen =============================
Signature · 1 line
2.21.0
PATCH 15/39 docs: early-userspace: move to driver-api guide
In reply to Mauro Carvalho ChehabThose documents describe a kAPI. So, add to the driver-api book.
---
.../{ => driver-api}/early-userspace/buffer-format.rst | 0
.../early-userspace/early_userspace_support.rst | 0
Documentation/{ => driver-api}/early-userspace/index.rst | 2 --
Documentation/driver-api/index.rst | 1 +
Documentation/filesystems/nfs/nfsroot.txt | 2 +-
Documentation/filesystems/ramfs-rootfs-initramfs.txt | 4 ++--
usr/Kconfig | 2 +-
7 files changed, 5 insertions(+), 6 deletions(-)
rename Documentation/{ => driver-api}/early-userspace/buffer-format.rst (100%)
rename Documentation/{ => driver-api}/early-userspace/early_userspace_support.rst (100%)
rename Documentation/{ => driver-api}/early-userspace/index.rst (95%)Documentation/driver-api/early-userspace/buffer-format.rst renamed from Documentation/early-userspace/buffer-format.rst +0 -0
Documentation/driver-api/early-userspace/early_userspace_support.rst renamed from Documentation/early-userspace/early_userspace_support.rst +0 -0
Documentation/driver-api/early-userspace/index.rst renamed from Documentation/early-userspace/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =============== Early Userspace ===============
Documentation/driver-api/index.rst +1 -0
@@ -16,6 +16,7 @@ available subsections can be seen below. basics infrastructure + early-userspace/index pm/index clk device-io
Documentation/filesystems/nfs/nfsroot.txt +1 -1
@@ -239,7 +239,7 @@ rdinit=<executable file> A description of the process of mounting the root file system can be found in: - Documentation/early-userspace/early_userspace_support.rst + Documentation/driver-api/early-userspace/early_userspace_support.rst
Documentation/filesystems/ramfs-rootfs-initramfs.txt +2 -2
@@ -105,7 +105,7 @@ All this differs from the old initrd in several ways: - The old initrd file was a gzipped filesystem image (in some file format, such as ext2, that needed a driver built into the kernel), while the new initramfs archive is a gzipped cpio archive (like tar only simpler, - see cpio(1) and Documentation/early-userspace/buffer-format.rst). The + see cpio(1) and Documentation/driver-api/early-userspace/buffer-format.rst). The kernel's cpio extraction code is not only extremely small, it's also __init text and data that can be discarded during the boot process.
@@ -159,7 +159,7 @@ One advantage of the configuration file is that root access is not required to set permissions or create device nodes in the new archive. (Note that those two example "file" entries expect to find files named "init.sh" and "busybox" in a directory called "initramfs", under the linux-2.6.* directory. See -Documentation/early-userspace/early_userspace_support.rst for more details.) +Documentation/driver-api/early-userspace/early_userspace_support.rst for more details.) The kernel does not depend on external cpio tools. If you specify a directory instead of a configuration file, the kernel's build infrastructure
usr/Kconfig +1 -1
@@ -18,7 +18,7 @@ config INITRAMFS_SOURCE When multiple directories and files are specified then the initramfs image will be the aggregate of all of them. - See <file:Documentation/early-userspace/early_userspace_support.rst> for more details. + See <file:Documentation/driver-api/early-userspace/early_userspace_support.rst> for more details. If you are not sure, leave it blank.
Signature · 1 line
2.21.0
PATCH 19/39 docs: blockdev: add it to the admin-guide
In reply to Mauro Carvalho ChehabThe blockdev book basically contains user-faced documentation.
---
.../blockdev/drbd/DRBD-8.3-data-packets.svg | 0
.../blockdev/drbd/DRBD-data-packets.svg | 0
.../blockdev/drbd/conn-states-8.dot | 0
.../blockdev/drbd/data-structure-v9.rst | 0
.../blockdev/drbd/disk-states-8.dot | 0
.../drbd/drbd-connection-state-overview.dot | 0
.../blockdev/drbd/figures.rst | 0
.../{ => admin-guide}/blockdev/drbd/index.rst | 0
.../blockdev/drbd/node-states-8.dot | 1 -
.../{ => admin-guide}/blockdev/floppy.rst | 0
.../{ => admin-guide}/blockdev/index.rst | 2 --
.../{ => admin-guide}/blockdev/nbd.rst | 0
.../{ => admin-guide}/blockdev/paride.rst | 0
.../{ => admin-guide}/blockdev/ramdisk.rst | 0
.../{ => admin-guide}/blockdev/zram.rst | 0
Documentation/admin-guide/index.rst | 1 +
.../admin-guide/kernel-parameters.txt | 18 +++++++++---------
MAINTAINERS | 10 +++++-----
drivers/block/Kconfig | 8 ++++----
drivers/block/floppy.c | 2 +-
drivers/block/zram/Kconfig | 6 +++---
tools/testing/selftests/zram/README | 2 +-
22 files changed, 24 insertions(+), 26 deletions(-)
rename Documentation/{ => admin-guide}/blockdev/drbd/DRBD-8.3-data-packets.svg (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/DRBD-data-packets.svg (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/conn-states-8.dot (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/data-structure-v9.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/disk-states-8.dot (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/drbd-connection-state-overview.dot (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/figures.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/index.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/node-states-8.dot (99%)
rename Documentation/{ => admin-guide}/blockdev/floppy.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/index.rst (94%)
rename Documentation/{ => admin-guide}/blockdev/nbd.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/paride.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/ramdisk.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/zram.rst (100%)Documentation/admin-guide/blockdev/drbd/DRBD-8.3-data-packets.svg renamed from Documentation/blockdev/drbd/DRBD-8.3-data-packets.svg +0 -0
Documentation/admin-guide/blockdev/drbd/DRBD-data-packets.svg renamed from Documentation/blockdev/drbd/DRBD-data-packets.svg +0 -0
Documentation/admin-guide/blockdev/drbd/conn-states-8.dot renamed from Documentation/blockdev/drbd/conn-states-8.dot +0 -0
Documentation/admin-guide/blockdev/drbd/data-structure-v9.rst renamed from Documentation/blockdev/drbd/data-structure-v9.rst +0 -0
Documentation/admin-guide/blockdev/drbd/disk-states-8.dot renamed from Documentation/blockdev/drbd/disk-states-8.dot +0 -0
Documentation/admin-guide/blockdev/drbd/drbd-connection-state-overview.dot renamed from Documentation/blockdev/drbd/drbd-connection-state-overview.dot +0 -0
Documentation/admin-guide/blockdev/drbd/figures.rst renamed from Documentation/blockdev/drbd/figures.rst +0 -0
Documentation/admin-guide/blockdev/drbd/index.rst renamed from Documentation/blockdev/drbd/index.rst +0 -0
Documentation/admin-guide/blockdev/drbd/node-states-8.dot renamed from Documentation/blockdev/drbd/node-states-8.dot +0 -1
@@ -11,4 +11,3 @@ digraph peer_states { Unknown -> Primary [ label = "connected" ] Unknown -> Secondary [ label = "connected" ] } -
Documentation/admin-guide/blockdev/floppy.rst renamed from Documentation/blockdev/floppy.rst +0 -0
Documentation/admin-guide/blockdev/index.rst renamed from Documentation/blockdev/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =========================== The Linux RapidIO Subsystem ===========================
Documentation/admin-guide/blockdev/nbd.rst renamed from Documentation/blockdev/nbd.rst +0 -0
Documentation/admin-guide/blockdev/paride.rst renamed from Documentation/blockdev/paride.rst +0 -0
Documentation/admin-guide/blockdev/ramdisk.rst renamed from Documentation/blockdev/ramdisk.rst +0 -0
Documentation/admin-guide/blockdev/zram.rst renamed from Documentation/blockdev/zram.rst +0 -0
Documentation/admin-guide/index.rst +1 -0
@@ -73,6 +73,7 @@ configure specific aspects of kernel behavior to your liking. java ras bcache + blockdev/index ext4 pm/index thunderbolt
Documentation/admin-guide/kernel-parameters.txt +9 -9
@@ -1249,7 +1249,7 @@ See also Documentation/fault-injection/. floppy= [HW] - See Documentation/blockdev/floppy.rst. + See Documentation/admin-guide/blockdev/floppy.rst. force_pal_cache_flush [IA-64] Avoid check_sal_cache_flush which may hang on
@@ -2247,7 +2247,7 @@ memblock=debug [KNL] Enable memblock debug messages. load_ramdisk= [RAM] List of ramdisks to load from floppy - See Documentation/blockdev/ramdisk.rst. + See Documentation/admin-guide/blockdev/ramdisk.rst. lockd.nlm_grace_period=P [NFS] Assign grace period. Format: <integer>
@@ -3294,7 +3294,7 @@ pcd. [PARIDE] See header of drivers/block/paride/pcd.c. - See also Documentation/blockdev/paride.rst. + See also Documentation/admin-guide/blockdev/paride.rst. pci=option[,option...] [PCI] various PCI subsystem options.
@@ -3538,7 +3538,7 @@ needed on a platform with proper driver support. pd. [PARIDE] - See Documentation/blockdev/paride.rst. + See Documentation/admin-guide/blockdev/paride.rst. pdcchassis= [PARISC,HW] Disable/Enable PDC Chassis Status codes at boot time.
@@ -3553,10 +3553,10 @@ and performance comparison. pf. [PARIDE] - See Documentation/blockdev/paride.rst. + See Documentation/admin-guide/blockdev/paride.rst. pg. [PARIDE] - See Documentation/blockdev/paride.rst. + See Documentation/admin-guide/blockdev/paride.rst. pirq= [SMP,APIC] Manual mp-table setup See Documentation/x86/i386/IO-APIC.rst.
@@ -3668,7 +3668,7 @@ prompt_ramdisk= [RAM] List of RAM disks to prompt for floppy disk before loading. - See Documentation/blockdev/ramdisk.rst. + See Documentation/admin-guide/blockdev/ramdisk.rst. psi= [KNL] Enable or disable pressure stall information tracking.
@@ -3690,7 +3690,7 @@ pstore.backend= Specify the name of the pstore backend to use pt. [PARIDE] - See Documentation/blockdev/paride.rst. + See Documentation/admin-guide/blockdev/paride.rst. pti= [X86_64] Control Page Table Isolation of user and kernel address spaces. Disabling this feature
@@ -3719,7 +3719,7 @@ See Documentation/admin-guide/md.rst. ramdisk_size= [RAM] Sizes of RAM disks in kilobytes - See Documentation/blockdev/ramdisk.rst. + See Documentation/admin-guide/blockdev/ramdisk.rst. random.trust_cpu={on,off} [KNL] Enable or disable trusting the use of the
MAINTAINERS +5 -5
@@ -4974,7 +4974,7 @@ T: git git://git.linbit.com/drbd-8.4.git S: Supported F: drivers/block/drbd/ F: lib/lru_cache.c -F: Documentation/blockdev/drbd/ +F: Documentation/admin-guide/blockdev/ DRIVER CORE, KOBJECTS, DEBUGFS AND SYSFS M: Greg Kroah-Hartman <[email protected]>
@@ -11024,7 +11024,7 @@ M: Josef Bacik <[email protected]> S: Maintained L: [email protected] L: [email protected] -F: Documentation/blockdev/nbd.rst +F: Documentation/admin-guide/blockdev/nbd.rst F: drivers/block/nbd.c F: include/trace/events/nbd.h F: include/uapi/linux/nbd.h
@@ -12028,7 +12028,7 @@ PARIDE DRIVERS FOR PARALLEL PORT IDE DEVICES M: Tim Waugh <[email protected]> L: [email protected] (subscribers-only) S: Maintained -F: Documentation/blockdev/paride.rst +F: Documentation/admin-guide/blockdev/paride.rst F: drivers/block/paride/ PARISC ARCHITECTURE
@@ -13310,7 +13310,7 @@ F: drivers/net/wireless/ralink/rt2x00/ RAMDISK RAM BLOCK DEVICE DRIVER M: Jens Axboe <[email protected]> S: Maintained -F: Documentation/blockdev/ramdisk.rst +F: Documentation/admin-guide/blockdev/ramdisk.rst F: drivers/block/brd.c RANCHU VIRTUAL BOARD FOR MIPS
@@ -17672,7 +17672,7 @@ R: Sergey Senozhatsky <[email protected]> L: [email protected] S: Maintained F: drivers/block/zram/ -F: Documentation/blockdev/zram.rst +F: Documentation/admin-guide/blockdev/zram.rst ZS DECSTATION Z85C30 SERIAL DRIVER M: "Maciej W. Rozycki" <[email protected]>
drivers/block/Kconfig +4 -4
@@ -31,7 +31,7 @@ config BLK_DEV_FD If you want to use the floppy disk drive(s) of your PC under Linux, say Y. Information about this driver, especially important for IBM Thinkpad users, is contained in - <file:Documentation/blockdev/floppy.rst>. + <file:Documentation/admin-guide/blockdev/floppy.rst>. That file also contains the location of the Floppy driver FAQ as well as location of the fdutils package used to configure additional parameters of the driver at run time.
@@ -96,7 +96,7 @@ config PARIDE your computer's parallel port. Most of them are actually IDE devices using a parallel port IDE adapter. This option enables the PARIDE subsystem which contains drivers for many of these external drives. - Read <file:Documentation/blockdev/paride.rst> for more information. + Read <file:Documentation/admin-guide/blockdev/paride.rst> for more information. If you have said Y to the "Parallel-port support" configuration option, you may share a single port between your printer and other
@@ -261,7 +261,7 @@ config BLK_DEV_NBD userland (making server and client physically the same computer, communicating using the loopback network device). - Read <file:Documentation/blockdev/nbd.rst> for more information, + Read <file:Documentation/admin-guide/blockdev/nbd.rst> for more information, especially about where to find the server code, which runs in user space and does not need special kernel support.
@@ -303,7 +303,7 @@ config BLK_DEV_RAM during the initial install of Linux. Note that the kernel command line option "ramdisk=XX" is now obsolete. - For details, read <file:Documentation/blockdev/ramdisk.rst>. + For details, read <file:Documentation/admin-guide/blockdev/ramdisk.rst>. To compile this driver as a module, choose M here: the module will be called brd. An alias "rd" has been defined
drivers/block/floppy.c +1 -1
@@ -4424,7 +4424,7 @@ static int __init floppy_setup(char *str)pr_cont ("\n" ); }else DPRINT ("botched floppy option\n" ); -DPRINT ("Read Documentation/blockdev/floppy.rst\n" ); +DPRINT ("Read Documentation/admin-guide/blockdev/floppy.rst\n" );return 0 ; }
drivers/block/zram/Kconfig +3 -3
@@ -12,7 +12,7 @@ config ZRAM It has several use cases, for example: /tmp storage, use as swap disks and maybe many more. - See Documentation/blockdev/zram.rst for more information. + See Documentation/admin-guide/blockdev/zram.rst for more information. config ZRAM_WRITEBACK bool "Write back incompressible or idle page to backing device"
@@ -26,7 +26,7 @@ config ZRAM_WRITEBACK With /sys/block/zramX/{idle,writeback}, application could ask idle page's writeback to the backing device to save in memory. - See Documentation/blockdev/zram.rst for more information. + See Documentation/admin-guide/blockdev/zram.rst for more information. config ZRAM_MEMORY_TRACKING bool "Track zRam block status"
@@ -36,4 +36,4 @@ config ZRAM_MEMORY_TRACKING of zRAM. Admin could see the information via /sys/kernel/debug/zram/zramX/block_state. - See Documentation/blockdev/zram.rst for more information. + See Documentation/admin-guide/blockdev/zram.rst for more information.
tools/testing/selftests/zram/README +1 -1
@@ -37,4 +37,4 @@ Commands required for testing: - mkfs/ mkfs.ext4 For more information please refer: -kernel-source-tree/Documentation/blockdev/zram.rst +kernel-source-tree/Documentation/admin-guide/blockdev/zram.rst
Signature · 1 line
2.21.0
PATCH 31/39 docs: driver-api: add remaining converted dirs to it
In reply to Mauro Carvalho ChehabThere are a number of driver-specific descriptions that contain a mix of userspace and kernelspace documentation. Just like we did with other similar subsystems, add them at the driver-api groupset, but don't move the directories.
--- Documentation/driver-api/index.rst | 2 ++ Documentation/driver-api/pps.rst | 2 +- Documentation/driver-api/ptp.rst | 2 +- Documentation/index.rst | 3 +++ Documentation/mic/index.rst | 2 -- Documentation/phy/samsung-usb2.rst | 2 -- Documentation/scheduler/index.rst | 2 -- 7 files changed, 7 insertions(+), 8 deletions(-)
Documentation/driver-api/index.rst +2 -0
@@ -83,6 +83,8 @@ available subsections can be seen below. ntb nvmem parport-lowlevel + pps + ptp pti_intel_mid pwm rfkill
Documentation/driver-api/pps.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ====================== PPS - Pulse Per Second
Documentation/driver-api/ptp.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 =========================================== PTP hardware clock infrastructure for Linux
Documentation/index.rst +3 -0
@@ -111,6 +111,9 @@ needed). PCI/index usb/index misc-devices/index + mic/index + phy/samsung-usb2 + scheduler/index Architecture-specific documentation -----------------------------------
Documentation/mic/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============================================= Intel Many Integrated Core (MIC) architecture =============================================
Documentation/phy/samsung-usb2.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ==================================== Samsung USB 2.0 PHY adaptation layer ====================================
Documentation/scheduler/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =============== Linux Scheduler ===============
Signature · 1 line
2.21.0
PATCH 38/39 docs: locking: add it to the main index
In reply to Mauro Carvalho ChehabThe locking directory is part of the Kernel API bookset. Add it to the index file.
--- Documentation/index.rst | 1 + Documentation/locking/index.rst | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-)
Documentation/index.rst +1 -0
@@ -96,6 +96,7 @@ needed). driver-api/index core-api/index + locking/index accounting/index block/index cdrom/index
Documentation/locking/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ======= locking
Signature · 1 line
2.21.0
PATCH 21/39 docs: x86: move two x86-specific files to x86 arch dir
In reply to Mauro Carvalho ChehabThose two docs belong to the x86 architecture:
Documentation/Intel-IOMMU.txt -> Documentation/x86/intel-iommu.rst Documentation/intel_txt.txt -> Documentation/x86/intel_txt.rst
---
Documentation/x86/index.rst | 2 ++
Documentation/{Intel-IOMMU.txt => x86/intel-iommu.rst} | 0
Documentation/{intel_txt.txt => x86/intel_txt.rst} | 0
MAINTAINERS | 2 +-
security/Kconfig | 2 +-
5 files changed, 4 insertions(+), 2 deletions(-)
rename Documentation/{Intel-IOMMU.txt => x86/intel-iommu.rst} (100%)
rename Documentation/{intel_txt.txt => x86/intel_txt.rst} (100%)Documentation/x86/index.rst +2 -0
@@ -20,6 +20,8 @@ x86-specific Documentation mtrr pat intel_mpx + intel-iommu + intel_txt amd-memory-encryption pti mds
Documentation/x86/intel-iommu.rst renamed from Documentation/Intel-IOMMU.txt +0 -0
Documentation/x86/intel_txt.rst renamed from Documentation/intel_txt.txt +0 -0
MAINTAINERS +1 -1
@@ -8259,7 +8259,7 @@ L: [email protected] W: http://tboot.sourceforge.net T: hg http://tboot.hg.sourceforge.net:8000/hgroot/tboot/tboot S: Supported -F: Documentation/intel_txt.txt +F: Documentation/x86/intel_txt.rst F: include/linux/tboot.h F: arch/x86/kernel/tboot.c
security/Kconfig +1 -1
@@ -121,7 +121,7 @@ config INTEL_TXT See <http://www.intel.com/technology/security/> for more information about Intel(R) TXT. See <http://tboot.sourceforge.net> for more information about tboot. - See Documentation/intel_txt.txt for a description of how to enable + See Documentation/x86/intel_txt.rst for a description of how to enable Intel TXT support in a kernel boot. If you are unsure as to whether this is required, answer N.
Signature · 1 line
2.21.0
cover Don't let ReST documents orphaned
The goal on this series is to not let ReST documents orphaned.
It moves files that are already on ReST format to a better place, when needed, and add them to the documentation body.
On my past attempt, I was too "aggressive" trying to move all files under Documentation/*.txt to some place. It ends that I did some mistakes, so, on this series, I opted to do the reverse: I only moved files that seemed to obviously belong to some place.
So, after this patch series, there will still 44 orphaned document files under Documentation/*.txt, to be addressed on a next Kernel version.
After this series, there will be "only" 386 files with the .txt extension:
$ find Documentation/ -name '*.txt'|grep -v features/|grep -v devicetree|grep -v output|wc -l 386
(I'm excluding features, as those aren't really a text file, but a sort of textual database)
The end result of this patch series (plus the other ones I sent today) is at:
https://www.infradead.org/~mchehab/rst_conversion/
And the full documentation patch series at:
https://git.linuxtv.org/mchehab/experimental.git/log/?h=convert_rst_renames_v7.1
Mauro Carvalho Chehab (39):
docs: thermal: add it to the driver API
docs: rapidio: add it to the driver API
docs: perf: move to the admin-guide
docs: nvdimm: add it to the driver-api book
docs: namespace: move it to the admin-guide
docs: mtd: move it to the driver-api book
docs: nfc: add it to the driver-api book
docs: mmc: move it to the driver-api
docs: md: move it to the driver-api book
docs: leds: add it to the driver-api book
docs: ioctl: add it to the uAPI guide
docs: interconnect.rst: add it to the driver-api guide
docs: add arch doc directories to the index
docs: device-mapper: move it to the admin-guide
docs: early-userspace: move to driver-api guide
docs: admin-guide: move sysctl directory to it
docs: admin-guide: add laptops documentation
docs: admin-guide: add kdump documentation into it
docs: blockdev: add it to the admin-guide
docs: security: move some books to it and update
docs: x86: move two x86-specific files to x86 arch dir
docs: ocxl.rst: add it to the uAPI book
docs: lp855x-driver.rst: add it to the driver-api book
docs: driver-model: move it to the driver-api book
docs: add some documentation dirs to the driver-api book
docs: aoe: add it to the driver-api book
docs: cgroup-v1: add it to the admin-guide book
docs: admin-guide: add a series of orphaned documents
docs: driver-api: add a series of orphaned documents
docs: driver-api: add xilinx driver API documentation
docs: driver-api: add remaining converted dirs to it
docs: serial: move it to the driver-api
docs: phy: place documentation under driver-api
docs: add a memory-devices subdir to driver-api
docs: infiniband: add it to the driver-api bookset
docs: add SPDX tags to new index files
docs: adds some directories to the main documentation index
docs: locking: add it to the main index
docs: gpio: add sysfs interface to the admin-guide
CREDITS | 2 +-
Documentation/ABI/obsolete/sysfs-gpio | 2 +-
Documentation/ABI/removed/sysfs-class-rfkill | 2 +-
Documentation/ABI/stable/sysfs-class-rfkill | 2 +-
Documentation/ABI/stable/sysfs-devices-node | 2 +-
Documentation/ABI/testing/procfs-diskstats | 2 +-
Documentation/ABI/testing/sysfs-block | 2 +-
Documentation/ABI/testing/sysfs-block-device | 2 +-
.../ABI/testing/sysfs-class-switchtec | 2 +-
.../ABI/testing/sysfs-devices-system-cpu | 4 +-
.../ABI/testing/sysfs-platform-asus-laptop | 2 +-
Documentation/accounting/index.rst | 2 +-
Documentation/{ => admin-guide}/aoe/aoe.rst | 4 +-
.../{ => admin-guide}/aoe/autoload.sh | 0
.../{ => admin-guide}/aoe/examples.rst | 0
Documentation/{ => admin-guide}/aoe/index.rst | 2 -
Documentation/{ => admin-guide}/aoe/status.sh | 0
Documentation/{ => admin-guide}/aoe/todo.rst | 0
.../{ => admin-guide}/aoe/udev-install.sh | 0
Documentation/{ => admin-guide}/aoe/udev.txt | 2 +-
.../blockdev/drbd/DRBD-8.3-data-packets.svg | 0
.../blockdev/drbd/DRBD-data-packets.svg | 0
.../blockdev/drbd/conn-states-8.dot | 0
.../blockdev/drbd/data-structure-v9.rst | 0
.../blockdev/drbd/disk-states-8.dot | 0
.../drbd/drbd-connection-state-overview.dot | 0
.../blockdev/drbd/figures.rst | 2 +
.../{ => admin-guide}/blockdev/drbd/index.rst | 0
.../blockdev/drbd/node-states-8.dot | 1 -
.../{ => admin-guide}/blockdev/floppy.rst | 0
.../{ => admin-guide}/blockdev/index.rst | 2 +-
.../{ => admin-guide}/blockdev/nbd.rst | 0
.../{ => admin-guide}/blockdev/paride.rst | 0
.../{ => admin-guide}/blockdev/ramdisk.rst | 0
.../{ => admin-guide}/blockdev/zram.rst | 0
.../{btmrvl.txt => admin-guide/btmrvl.rst} | 0
Documentation/admin-guide/bug-hunting.rst | 4 +-
.../cgroup-v1/blkio-controller.rst | 0
.../{ => admin-guide}/cgroup-v1/cgroups.rst | 4 +-
.../{ => admin-guide}/cgroup-v1/cpuacct.rst | 0
.../{ => admin-guide}/cgroup-v1/cpusets.rst | 2 +-
.../{ => admin-guide}/cgroup-v1/devices.rst | 0
.../cgroup-v1/freezer-subsystem.rst | 0
.../{ => admin-guide}/cgroup-v1/hugetlb.rst | 0
.../{ => admin-guide}/cgroup-v1/index.rst | 2 -
.../cgroup-v1/memcg_test.rst | 4 +-
.../{ => admin-guide}/cgroup-v1/memory.rst | 0
.../{ => admin-guide}/cgroup-v1/net_cls.rst | 0
.../{ => admin-guide}/cgroup-v1/net_prio.rst | 0
.../{ => admin-guide}/cgroup-v1/pids.rst | 0
.../{ => admin-guide}/cgroup-v1/rdma.rst | 0
Documentation/admin-guide/cgroup-v2.rst | 2 +-
.../clearing-warn-once.rst} | 0
.../cpu-load.rst} | 0
.../cputopology.rst} | 0
.../device-mapper/cache-policies.rst | 0
.../{ => admin-guide}/device-mapper/cache.rst | 0
.../{ => admin-guide}/device-mapper/delay.rst | 0
.../device-mapper/dm-crypt.rst | 0
.../device-mapper/dm-dust.txt | 0
.../device-mapper/dm-flakey.rst | 0
.../device-mapper/dm-init.rst | 0
.../device-mapper/dm-integrity.rst | 0
.../{ => admin-guide}/device-mapper/dm-io.rst | 0
.../device-mapper/dm-log.rst | 0
.../device-mapper/dm-queue-length.rst | 0
.../device-mapper/dm-raid.rst | 0
.../device-mapper/dm-service-time.rst | 0
.../device-mapper/dm-uevent.rst | 0
.../device-mapper/dm-zoned.rst | 0
.../{ => admin-guide}/device-mapper/era.rst | 0
.../{ => admin-guide}/device-mapper/index.rst | 2 -
.../device-mapper/kcopyd.rst | 0
.../device-mapper/linear.rst | 0
.../device-mapper/log-writes.rst | 0
.../device-mapper/persistent-data.rst | 0
.../device-mapper/snapshot.rst | 0
.../device-mapper/statistics.rst | 4 +-
.../device-mapper/striped.rst | 0
.../device-mapper/switch.rst | 0
.../device-mapper/thin-provisioning.rst | 0
.../device-mapper/unstriped.rst | 0
.../device-mapper/verity.rst | 0
.../device-mapper/writecache.rst | 0
.../{ => admin-guide}/device-mapper/zero.rst | 0
.../efi-stub.rst} | 0
.../{ => admin-guide}/gpio/index.rst | 2 +-
.../{ => admin-guide}/gpio/sysfs.rst | 0
.../{highuid.txt => admin-guide/highuid.rst} | 0
Documentation/admin-guide/hw-vuln/l1tf.rst | 2 +-
.../hw_random.rst} | 0
Documentation/admin-guide/index.rst | 28 +++++++
.../{iostats.txt => admin-guide/iostats.rst} | 0
.../{ => admin-guide}/kdump/gdbmacros.txt | 0
.../{ => admin-guide}/kdump/index.rst | 1 -
.../{ => admin-guide}/kdump/kdump.rst | 0
.../{ => admin-guide}/kdump/vmcoreinfo.rst | 0
.../admin-guide/kernel-parameters.txt | 36 ++++----
.../kernel-per-CPU-kthreads.rst} | 2 +-
.../{ => admin-guide}/laptops/asus-laptop.rst | 0
.../laptops/disk-shock-protection.rst | 0
.../{ => admin-guide}/laptops/index.rst | 2 +-
.../{ => admin-guide}/laptops/laptop-mode.rst | 0
.../{ => admin-guide}/laptops/lg-laptop.rst | 1 -
.../{ => admin-guide}/laptops/sony-laptop.rst | 0
.../{ => admin-guide}/laptops/sonypi.rst | 0
.../laptops/thinkpad-acpi.rst | 6 +-
.../laptops/toshiba_haps.rst | 0
.../lcd-panel-cgram.rst | 2 -
.../{ldm.txt => admin-guide/ldm.rst} | 0
.../lockup-watchdogs.rst} | 0
.../mm/cma_debugfs.rst} | 2 -
Documentation/admin-guide/mm/index.rst | 3 +-
Documentation/admin-guide/mm/ksm.rst | 2 +-
.../admin-guide/mm/numa_memory_policy.rst | 2 +-
.../namespaces/compatibility-list.rst | 0
.../{ => admin-guide}/namespaces/index.rst | 2 +-
.../namespaces/resource-control.rst | 0
.../numastat.rst} | 0
.../{ => admin-guide}/perf/arm-ccn.rst | 0
.../{ => admin-guide}/perf/arm_dsu_pmu.rst | 0
.../{ => admin-guide}/perf/hisi-pmu.rst | 0
.../{ => admin-guide}/perf/index.rst | 2 +-
.../{ => admin-guide}/perf/qcom_l2_pmu.rst | 0
.../{ => admin-guide}/perf/qcom_l3_pmu.rst | 0
.../{ => admin-guide}/perf/thunderx2-pmu.rst | 0
.../{ => admin-guide}/perf/xgene-pmu.rst | 0
.../{pnp.txt => admin-guide/pnp.rst} | 0
.../{driver-api => admin-guide}/rapidio.rst | 0
.../{rtc.txt => admin-guide/rtc.rst} | 0
.../{svga.txt => admin-guide/svga.rst} | 0
.../{ => admin-guide}/sysctl/abi.rst | 0
Documentation/{ => admin-guide}/sysctl/fs.rst | 0
.../{ => admin-guide}/sysctl/index.rst | 2 -
.../{ => admin-guide}/sysctl/kernel.rst | 2 +-
.../{ => admin-guide}/sysctl/net.rst | 0
.../{ => admin-guide}/sysctl/sunrpc.rst | 0
.../{ => admin-guide}/sysctl/user.rst | 0
Documentation/{ => admin-guide}/sysctl/vm.rst | 4 +-
.../video-output.rst} | 0
Documentation/arm/index.rst | 2 +-
Documentation/arm/nwfpe/index.rst | 2 +
Documentation/arm/omap/index.rst | 2 +
Documentation/arm/sa1100/index.rst | 2 +
Documentation/arm/samsung-s3c24xx/index.rst | 2 +
Documentation/arm/samsung/index.rst | 2 +
Documentation/arm64/index.rst | 2 -
Documentation/block/bfq-iosched.rst | 2 +-
Documentation/block/index.rst | 2 +-
Documentation/cdrom/index.rst | 2 +-
Documentation/core-api/printk-formats.rst | 2 +-
.../devicetree/bindings/phy/phy-bindings.txt | 2 +-
.../devicetree/bindings/phy/phy-pxa-usb.txt | 2 +-
.../backlight/lp855x-driver.rst | 2 -
.../bt8xxgpio.rst} | 0
.../{connector => driver-api}/connector.rst | 2 +-
.../{console => driver-api}/console.rst | 2 +-
.../{dcdbas.txt => driver-api/dcdbas.rst} | 0
.../{dell_rbu.txt => driver-api/dell_rbu.rst} | 0
.../{ => driver-api}/driver-model/binding.rst | 0
.../{ => driver-api}/driver-model/bus.rst | 0
.../{ => driver-api}/driver-model/class.rst | 0
.../driver-model/design-patterns.rst | 0
.../{ => driver-api}/driver-model/device.rst | 0
.../{ => driver-api}/driver-model/devres.rst | 0
.../{ => driver-api}/driver-model/driver.rst | 0
.../{ => driver-api}/driver-model/index.rst | 2 -
.../driver-model/overview.rst | 0
.../driver-model/platform.rst | 0
.../{ => driver-api}/driver-model/porting.rst | 2 +-
.../early-userspace/buffer-format.rst | 0
.../early_userspace_support.rst | 0
.../early-userspace/index.rst | 2 +-
.../{EDID/howto.rst => driver-api/edid.rst} | 2 +-
.../{eisa.txt => driver-api/eisa.rst} | 4 +-
Documentation/driver-api/gpio/driver.rst | 2 +-
Documentation/driver-api/index.rst | 44 +++++++++-
.../interconnect.rst | 2 -
Documentation/{isa.txt => driver-api/isa.rst} | 0
.../{isapnp.txt => driver-api/isapnp.rst} | 0
.../pblk.txt => driver-api/lightnvm-pblk.rst} | 0
Documentation/{ => driver-api}/md/index.rst | 2 +-
.../{ => driver-api}/md/md-cluster.rst | 0
.../{ => driver-api}/md/raid5-cache.rst | 0
.../{ => driver-api}/md/raid5-ppl.rst | 0
.../driver-api/memory-devices/index.rst | 18 ++++
.../memory-devices/ti-emif.rst | 2 +-
.../memory-devices}/ti-gpmc.rst | 2 +-
.../men-chameleon-bus.rst} | 0
Documentation/{ => driver-api}/mmc/index.rst | 2 +-
.../{ => driver-api}/mmc/mmc-async-req.rst | 0
.../{ => driver-api}/mmc/mmc-dev-attrs.rst | 0
.../{ => driver-api}/mmc/mmc-dev-parts.rst | 0
.../{ => driver-api}/mmc/mmc-tools.rst | 0
Documentation/{ => driver-api}/mtd/index.rst | 2 +-
.../{ => driver-api}/mtd/intel-spi.rst | 0
.../{ => driver-api}/mtd/nand_ecc.rst | 0
.../{ => driver-api}/mtd/spi-nor.rst | 0
Documentation/{ => driver-api}/nfc/index.rst | 2 +-
.../{ => driver-api}/nfc/nfc-hci.rst | 0
.../{ => driver-api}/nfc/nfc-pn544.rst | 0
Documentation/{ntb.txt => driver-api/ntb.rst} | 0
Documentation/{ => driver-api}/nvdimm/btt.rst | 0
.../{ => driver-api}/nvdimm/index.rst | 2 +-
.../{ => driver-api}/nvdimm/nvdimm.rst | 0
.../{ => driver-api}/nvdimm/security.rst | 0
Documentation/{nvmem => driver-api}/nvmem.rst | 2 +-
.../parport-lowlevel.rst} | 0
Documentation/driver-api/phy/index.rst | 18 ++++
.../{phy.txt => driver-api/phy/phy.rst} | 0
.../{ => driver-api}/phy/samsung-usb2.rst | 2 -
Documentation/driver-api/pps.rst | 2 +-
.../{pti => driver-api}/pti_intel_mid.rst | 2 +-
Documentation/driver-api/ptp.rst | 2 +-
Documentation/{pwm.txt => driver-api/pwm.rst} | 0
.../{ => driver-api}/rapidio/index.rst | 2 +-
.../{ => driver-api}/rapidio/mport_cdev.rst | 0
.../{ => driver-api}/rapidio/rapidio.rst | 0
.../{ => driver-api}/rapidio/rio_cm.rst | 0
.../{ => driver-api}/rapidio/sysfs.rst | 0
.../{ => driver-api}/rapidio/tsi721.rst | 0
.../{rfkill.txt => driver-api/rfkill.rst} | 0
.../{ => driver-api}/serial/cyclades_z.rst | 0
.../{ => driver-api}/serial/driver.rst | 2 +-
.../{ => driver-api}/serial/index.rst | 2 +-
.../{ => driver-api}/serial/moxa-smartio.rst | 0
.../{ => driver-api}/serial/n_gsm.rst | 0
.../{ => driver-api}/serial/rocket.rst | 0
.../serial/serial-iso7816.rst | 0
.../{ => driver-api}/serial/serial-rs485.rst | 0
Documentation/{ => driver-api}/serial/tty.rst | 0
.../{sgi-ioc4.txt => driver-api/sgi-ioc4.rst} | 0
.../{SM501.txt => driver-api/sm501.rst} | 0
.../smsc_ece1099.rst} | 0
.../switchtec.rst} | 2 +-
.../sync_file.rst} | 0
.../thermal/cpu-cooling-api.rst | 0
.../thermal/exynos_thermal.rst | 0
.../thermal/exynos_thermal_emulation.rst | 0
.../{ => driver-api}/thermal/index.rst | 2 +-
.../thermal/intel_powerclamp.rst | 0
.../thermal/nouveau_thermal.rst | 0
.../thermal/power_allocator.rst | 0
.../{ => driver-api}/thermal/sysfs-api.rst | 12 +--
.../thermal/x86_pkg_temperature_thermal.rst | 2 +-
.../vfio-mediated-device.rst} | 2 +-
.../{vfio.txt => driver-api/vfio.rst} | 0
.../{ => driver-api}/xilinx/eemi.rst | 0
.../{ => driver-api}/xilinx/index.rst | 1 -
.../{xillybus.txt => driver-api/xillybus.rst} | 0
.../{zorro.txt => driver-api/zorro.rst} | 0
Documentation/fault-injection/index.rst | 2 +-
Documentation/fb/fbcon.rst | 4 +-
Documentation/fb/index.rst | 2 +-
Documentation/fb/vesafb.rst | 2 +-
Documentation/filesystems/nfs/nfsroot.txt | 2 +-
Documentation/filesystems/proc.txt | 2 +-
.../filesystems/ramfs-rootfs-initramfs.txt | 4 +-
Documentation/filesystems/sysfs.txt | 2 +-
Documentation/filesystems/tmpfs.txt | 2 +-
.../firmware-guide/acpi/enumeration.rst | 2 +-
Documentation/fpga/index.rst | 2 +-
Documentation/hid/index.rst | 2 +-
Documentation/hwmon/submitting-patches.rst | 2 +-
Documentation/ia64/index.rst | 2 +-
Documentation/ide/index.rst | 2 +-
Documentation/iio/index.rst | 2 +-
Documentation/index.rst | 34 ++++++++
Documentation/infiniband/index.rst | 2 +-
Documentation/ioctl/index.rst | 2 +-
Documentation/ioctl/ioctl-number.rst | 2 -
Documentation/kbuild/index.rst | 2 +-
Documentation/leds/index.rst | 2 +-
Documentation/livepatch/index.rst | 2 +-
Documentation/locking/index.rst | 2 +-
Documentation/m68k/index.rst | 2 +-
Documentation/mic/index.rst | 2 -
Documentation/netlabel/index.rst | 2 +-
Documentation/networking/ip-sysctl.txt | 2 +-
Documentation/pcmcia/index.rst | 2 +-
Documentation/power/index.rst | 2 +-
.../powerpc/firmware-assisted-dump.rst | 2 +-
Documentation/powerpc/index.rst | 2 +-
Documentation/riscv/index.rst | 2 -
Documentation/s390/index.rst | 2 -
Documentation/s390/vfio-ccw.rst | 6 +-
Documentation/scheduler/index.rst | 2 -
Documentation/scheduler/sched-deadline.rst | 2 +-
Documentation/scheduler/sched-design-CFS.rst | 2 +-
Documentation/scheduler/sched-rt-group.rst | 2 +-
Documentation/security/index.rst | 5 +-
.../security/{LSM.rst => lsm-development.rst} | 0
Documentation/{lsm.txt => security/lsm.rst} | 0
Documentation/{SAK.txt => security/sak.rst} | 0
.../{siphash.txt => security/siphash.rst} | 0
Documentation/security/tpm/index.rst | 1 +
Documentation/security/tpm/xen-tpmfront.rst | 2 -
Documentation/sparc/index.rst | 2 -
Documentation/target/index.rst | 2 +-
Documentation/timers/index.rst | 2 +-
.../translations/zh_CN/filesystems/sysfs.txt | 2 +-
Documentation/translations/zh_CN/gpio.txt | 4 +-
.../translations/zh_CN/oops-tracing.txt | 4 +-
.../{ => userspace-api}/accelerators/ocxl.rst | 2 -
Documentation/userspace-api/index.rst | 1 +
Documentation/vm/numa.rst | 4 +-
Documentation/vm/page_migration.rst | 2 +-
Documentation/vm/unevictable-lru.rst | 4 +-
Documentation/w1/w1.netlink | 2 +-
Documentation/watchdog/hpwdt.rst | 2 +-
Documentation/watchdog/index.rst | 2 +-
Documentation/x86/index.rst | 2 +
.../{Intel-IOMMU.txt => x86/intel-iommu.rst} | 0
.../{intel_txt.txt => x86/intel_txt.rst} | 0
Documentation/x86/topology.rst | 2 +-
.../x86/x86_64/fake-numa-for-cpusets.rst | 4 +-
Documentation/xtensa/index.rst | 2 +-
MAINTAINERS | 82 +++++++++----------
Next/merge.log | 4 +-
arch/arm/Kconfig | 4 +-
arch/arm64/Kconfig | 2 +-
arch/parisc/Kconfig | 2 +-
arch/sh/Kconfig | 4 +-
arch/sparc/Kconfig | 2 +-
arch/x86/Kconfig | 8 +-
block/Kconfig | 2 +-
block/partitions/Kconfig | 2 +-
drivers/base/platform.c | 2 +-
drivers/block/Kconfig | 8 +-
drivers/block/floppy.c | 2 +-
drivers/block/zram/Kconfig | 6 +-
drivers/char/Kconfig | 6 +-
drivers/char/hw_random/core.c | 2 +-
drivers/dma-buf/Kconfig | 2 +-
drivers/gpio/Kconfig | 2 +-
drivers/gpio/gpio-cs5535.c | 2 +-
drivers/gpu/drm/Kconfig | 2 +-
drivers/md/Kconfig | 2 +-
drivers/md/dm-init.c | 2 +-
drivers/md/dm-raid.c | 2 +-
drivers/mtd/nand/raw/nand_ecc.c | 2 +-
drivers/net/ethernet/intel/ice/ice_main.c | 2 +-
drivers/nvdimm/Kconfig | 2 +-
drivers/pci/switch/Kconfig | 2 +-
drivers/perf/qcom_l3_pmu.c | 2 +-
drivers/platform/x86/Kconfig | 8 +-
drivers/platform/x86/dcdbas.c | 2 +-
drivers/platform/x86/dell_rbu.c | 2 +-
drivers/pnp/isapnp/Kconfig | 2 +-
drivers/rapidio/Kconfig | 2 +-
.../staging/unisys/Documentation/overview.txt | 4 +-
drivers/tty/Kconfig | 6 +-
drivers/tty/serial/ucc_uart.c | 2 +-
drivers/vfio/Kconfig | 2 +-
drivers/vfio/mdev/Kconfig | 2 +-
drivers/w1/Kconfig | 2 +-
fs/proc/Kconfig | 2 +-
include/linux/cgroup-defs.h | 2 +-
include/linux/device.h | 2 +-
include/linux/hw_random.h | 2 +-
include/linux/platform_device.h | 2 +-
include/linux/serial_core.h | 2 +-
include/linux/thermal.h | 4 +-
include/uapi/linux/bpf.h | 2 +-
init/Kconfig | 4 +-
kernel/cgroup/cpuset.c | 2 +-
kernel/panic.c | 2 +-
mm/swap.c | 2 +-
samples/Kconfig | 2 +-
scripts/coccinelle/free/devm_free.cocci | 2 +-
security/Kconfig | 2 +-
security/device_cgroup.c | 2 +-
tools/include/uapi/linux/bpf.h | 2 +-
tools/testing/selftests/zram/README | 2 +-
usr/Kconfig | 2 +-
375 files changed, 436 insertions(+), 318 deletions(-)
rename Documentation/{ => admin-guide}/aoe/aoe.rst (97%)
rename Documentation/{ => admin-guide}/aoe/autoload.sh (100%)
rename Documentation/{ => admin-guide}/aoe/examples.rst (100%)
rename Documentation/{ => admin-guide}/aoe/index.rst (95%)
rename Documentation/{ => admin-guide}/aoe/status.sh (100%)
rename Documentation/{ => admin-guide}/aoe/todo.rst (100%)
rename Documentation/{ => admin-guide}/aoe/udev-install.sh (100%)
rename Documentation/{ => admin-guide}/aoe/udev.txt (93%)
rename Documentation/{ => admin-guide}/blockdev/drbd/DRBD-8.3-data-packets.svg (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/DRBD-data-packets.svg (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/conn-states-8.dot (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/data-structure-v9.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/disk-states-8.dot (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/drbd-connection-state-overview.dot (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/figures.rst (95%)
rename Documentation/{ => admin-guide}/blockdev/drbd/index.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/drbd/node-states-8.dot (99%)
rename Documentation/{ => admin-guide}/blockdev/floppy.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/index.rst (83%)
rename Documentation/{ => admin-guide}/blockdev/nbd.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/paride.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/ramdisk.rst (100%)
rename Documentation/{ => admin-guide}/blockdev/zram.rst (100%)
rename Documentation/{btmrvl.txt => admin-guide/btmrvl.rst} (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/blkio-controller.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/cgroups.rst (99%)
rename Documentation/{ => admin-guide}/cgroup-v1/cpuacct.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/cpusets.rst (99%)
rename Documentation/{ => admin-guide}/cgroup-v1/devices.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/freezer-subsystem.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/hugetlb.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/index.rst (97%)
rename Documentation/{ => admin-guide}/cgroup-v1/memcg_test.rst (98%)
rename Documentation/{ => admin-guide}/cgroup-v1/memory.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/net_cls.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/net_prio.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/pids.rst (100%)
rename Documentation/{ => admin-guide}/cgroup-v1/rdma.rst (100%)
rename Documentation/{clearing-warn-once.txt => admin-guide/clearing-warn-once.rst} (100%)
rename Documentation/{cpu-load.txt => admin-guide/cpu-load.rst} (100%)
rename Documentation/{cputopology.txt => admin-guide/cputopology.rst} (100%)
rename Documentation/{ => admin-guide}/device-mapper/cache-policies.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/cache.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/delay.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-crypt.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-dust.txt (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-flakey.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-init.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-integrity.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-io.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-log.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-queue-length.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-raid.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-service-time.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-uevent.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/dm-zoned.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/era.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/index.rst (98%)
rename Documentation/{ => admin-guide}/device-mapper/kcopyd.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/linear.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/log-writes.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/persistent-data.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/snapshot.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/statistics.rst (98%)
rename Documentation/{ => admin-guide}/device-mapper/striped.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/switch.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/thin-provisioning.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/unstriped.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/verity.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/writecache.rst (100%)
rename Documentation/{ => admin-guide}/device-mapper/zero.rst (100%)
rename Documentation/{efi-stub.txt => admin-guide/efi-stub.rst} (100%)
rename Documentation/{ => admin-guide}/gpio/index.rst (78%)
rename Documentation/{ => admin-guide}/gpio/sysfs.rst (100%)
rename Documentation/{highuid.txt => admin-guide/highuid.rst} (100%)
rename Documentation/{hw_random.txt => admin-guide/hw_random.rst} (100%)
rename Documentation/{iostats.txt => admin-guide/iostats.rst} (100%)
rename Documentation/{ => admin-guide}/kdump/gdbmacros.txt (100%)
rename Documentation/{ => admin-guide}/kdump/index.rst (97%)
rename Documentation/{ => admin-guide}/kdump/kdump.rst (100%)
rename Documentation/{ => admin-guide}/kdump/vmcoreinfo.rst (100%)
rename Documentation/{kernel-per-CPU-kthreads.txt => admin-guide/kernel-per-CPU-kthreads.rst} (99%)
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 (84%)
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 (99%)
rename Documentation/{ => admin-guide}/laptops/toshiba_haps.rst (100%)
rename Documentation/{auxdisplay => admin-guide}/lcd-panel-cgram.rst (99%)
rename Documentation/{ldm.txt => admin-guide/ldm.rst} (100%)
rename Documentation/{lockup-watchdogs.txt => admin-guide/lockup-watchdogs.rst} (100%)
rename Documentation/{cma/debugfs.rst => admin-guide/mm/cma_debugfs.rst} (98%)
rename Documentation/{ => admin-guide}/namespaces/compatibility-list.rst (100%)
rename Documentation/{ => admin-guide}/namespaces/index.rst (74%)
rename Documentation/{ => admin-guide}/namespaces/resource-control.rst (100%)
rename Documentation/{numastat.txt => admin-guide/numastat.rst} (100%)
rename Documentation/{ => admin-guide}/perf/arm-ccn.rst (100%)
rename Documentation/{ => admin-guide}/perf/arm_dsu_pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/hisi-pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/index.rst (85%)
rename Documentation/{ => admin-guide}/perf/qcom_l2_pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/qcom_l3_pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/thunderx2-pmu.rst (100%)
rename Documentation/{ => admin-guide}/perf/xgene-pmu.rst (100%)
rename Documentation/{pnp.txt => admin-guide/pnp.rst} (100%)
rename Documentation/{driver-api => admin-guide}/rapidio.rst (100%)
rename Documentation/{rtc.txt => admin-guide/rtc.rst} (100%)
rename Documentation/{svga.txt => admin-guide/svga.rst} (100%)
rename Documentation/{ => admin-guide}/sysctl/abi.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/fs.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/index.rst (99%)
rename Documentation/{ => admin-guide}/sysctl/kernel.rst (99%)
rename Documentation/{ => admin-guide}/sysctl/net.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/sunrpc.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/user.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/vm.rst (99%)
rename Documentation/{video-output.txt => admin-guide/video-output.rst} (100%)
rename Documentation/{ => driver-api}/backlight/lp855x-driver.rst (99%)
rename Documentation/{bt8xxgpio.txt => driver-api/bt8xxgpio.rst} (100%)
rename Documentation/{connector => driver-api}/connector.rst (99%)
rename Documentation/{console => driver-api}/console.rst (99%)
rename Documentation/{dcdbas.txt => driver-api/dcdbas.rst} (100%)
rename Documentation/{dell_rbu.txt => driver-api/dell_rbu.rst} (100%)
rename Documentation/{ => driver-api}/driver-model/binding.rst (100%)
rename Documentation/{ => driver-api}/driver-model/bus.rst (100%)
rename Documentation/{ => driver-api}/driver-model/class.rst (100%)
rename Documentation/{ => driver-api}/driver-model/design-patterns.rst (100%)
rename Documentation/{ => driver-api}/driver-model/device.rst (100%)
rename Documentation/{ => driver-api}/driver-model/devres.rst (100%)
rename Documentation/{ => driver-api}/driver-model/driver.rst (100%)
rename Documentation/{ => driver-api}/driver-model/index.rst (96%)
rename Documentation/{ => driver-api}/driver-model/overview.rst (100%)
rename Documentation/{ => driver-api}/driver-model/platform.rst (100%)
rename Documentation/{ => driver-api}/driver-model/porting.rst (99%)
rename Documentation/{ => driver-api}/early-userspace/buffer-format.rst (100%)
rename Documentation/{ => driver-api}/early-userspace/early_userspace_support.rst (100%)
rename Documentation/{ => driver-api}/early-userspace/index.rst (85%)
rename Documentation/{EDID/howto.rst => driver-api/edid.rst} (98%)
rename Documentation/{eisa.txt => driver-api/eisa.rst} (98%)
rename Documentation/{interconnect => driver-api}/interconnect.rst (99%)
rename Documentation/{isa.txt => driver-api/isa.rst} (100%)
rename Documentation/{isapnp.txt => driver-api/isapnp.rst} (100%)
rename Documentation/{lightnvm/pblk.txt => driver-api/lightnvm-pblk.rst} (100%)
rename Documentation/{ => driver-api}/md/index.rst (71%)
rename Documentation/{ => driver-api}/md/md-cluster.rst (100%)
rename Documentation/{ => driver-api}/md/raid5-cache.rst (100%)
rename Documentation/{ => driver-api}/md/raid5-ppl.rst (100%)
create mode 100644 Documentation/driver-api/memory-devices/index.rst
rename Documentation/{ => driver-api}/memory-devices/ti-emif.rst (98%)
rename Documentation/{bus-devices => driver-api/memory-devices}/ti-gpmc.rst (99%)
rename Documentation/{men-chameleon-bus.txt => driver-api/men-chameleon-bus.rst} (100%)
rename Documentation/{ => driver-api}/mmc/index.rst (82%)
rename Documentation/{ => driver-api}/mmc/mmc-async-req.rst (100%)
rename Documentation/{ => driver-api}/mmc/mmc-dev-attrs.rst (100%)
rename Documentation/{ => driver-api}/mmc/mmc-dev-parts.rst (100%)
rename Documentation/{ => driver-api}/mmc/mmc-tools.rst (100%)
rename Documentation/{ => driver-api}/mtd/index.rst (81%)
rename Documentation/{ => driver-api}/mtd/intel-spi.rst (100%)
rename Documentation/{ => driver-api}/mtd/nand_ecc.rst (100%)
rename Documentation/{ => driver-api}/mtd/spi-nor.rst (100%)
rename Documentation/{ => driver-api}/nfc/index.rst (78%)
rename Documentation/{ => driver-api}/nfc/nfc-hci.rst (100%)
rename Documentation/{ => driver-api}/nfc/nfc-pn544.rst (100%)
rename Documentation/{ntb.txt => driver-api/ntb.rst} (100%)
rename Documentation/{ => driver-api}/nvdimm/btt.rst (100%)
rename Documentation/{ => driver-api}/nvdimm/index.rst (82%)
rename Documentation/{ => driver-api}/nvdimm/nvdimm.rst (100%)
rename Documentation/{ => driver-api}/nvdimm/security.rst (100%)
rename Documentation/{nvmem => driver-api}/nvmem.rst (99%)
rename Documentation/{parport-lowlevel.txt => driver-api/parport-lowlevel.rst} (100%)
create mode 100644 Documentation/driver-api/phy/index.rst
rename Documentation/{phy.txt => driver-api/phy/phy.rst} (100%)
rename Documentation/{ => driver-api}/phy/samsung-usb2.rst (99%)
rename Documentation/{pti => driver-api}/pti_intel_mid.rst (99%)
rename Documentation/{pwm.txt => driver-api/pwm.rst} (100%)
rename Documentation/{ => driver-api}/rapidio/index.rst (82%)
rename Documentation/{ => driver-api}/rapidio/mport_cdev.rst (100%)
rename Documentation/{ => driver-api}/rapidio/rapidio.rst (100%)
rename Documentation/{ => driver-api}/rapidio/rio_cm.rst (100%)
rename Documentation/{ => driver-api}/rapidio/sysfs.rst (100%)
rename Documentation/{ => driver-api}/rapidio/tsi721.rst (100%)
rename Documentation/{rfkill.txt => driver-api/rfkill.rst} (100%)
rename Documentation/{ => driver-api}/serial/cyclades_z.rst (100%)
rename Documentation/{ => driver-api}/serial/driver.rst (99%)
rename Documentation/{ => driver-api}/serial/index.rst (90%)
rename Documentation/{ => driver-api}/serial/moxa-smartio.rst (100%)
rename Documentation/{ => driver-api}/serial/n_gsm.rst (100%)
rename Documentation/{ => driver-api}/serial/rocket.rst (100%)
rename Documentation/{ => driver-api}/serial/serial-iso7816.rst (100%)
rename Documentation/{ => driver-api}/serial/serial-rs485.rst (100%)
rename Documentation/{ => driver-api}/serial/tty.rst (100%)
rename Documentation/{sgi-ioc4.txt => driver-api/sgi-ioc4.rst} (100%)
rename Documentation/{SM501.txt => driver-api/sm501.rst} (100%)
rename Documentation/{smsc_ece1099.txt => driver-api/smsc_ece1099.rst} (100%)
rename Documentation/{switchtec.txt => driver-api/switchtec.rst} (97%)
rename Documentation/{sync_file.txt => driver-api/sync_file.rst} (100%)
rename Documentation/{ => driver-api}/thermal/cpu-cooling-api.rst (100%)
rename Documentation/{ => driver-api}/thermal/exynos_thermal.rst (100%)
rename Documentation/{ => driver-api}/thermal/exynos_thermal_emulation.rst (100%)
rename Documentation/{ => driver-api}/thermal/index.rst (86%)
rename Documentation/{ => driver-api}/thermal/intel_powerclamp.rst (100%)
rename Documentation/{ => driver-api}/thermal/nouveau_thermal.rst (100%)
rename Documentation/{ => driver-api}/thermal/power_allocator.rst (100%)
rename Documentation/{ => driver-api}/thermal/sysfs-api.rst (98%)
rename Documentation/{ => driver-api}/thermal/x86_pkg_temperature_thermal.rst (94%)
rename Documentation/{vfio-mediated-device.txt => driver-api/vfio-mediated-device.rst} (99%)
rename Documentation/{vfio.txt => driver-api/vfio.rst} (100%)
rename Documentation/{ => driver-api}/xilinx/eemi.rst (100%)
rename Documentation/{ => driver-api}/xilinx/index.rst (94%)
rename Documentation/{xillybus.txt => driver-api/xillybus.rst} (100%)
rename Documentation/{zorro.txt => driver-api/zorro.rst} (100%)
rename Documentation/security/{LSM.rst => lsm-development.rst} (100%)
rename Documentation/{lsm.txt => security/lsm.rst} (100%)
rename Documentation/{SAK.txt => security/sak.rst} (100%)
rename Documentation/{siphash.txt => security/siphash.rst} (100%)
rename Documentation/{ => userspace-api}/accelerators/ocxl.rst (99%)
rename Documentation/{Intel-IOMMU.txt => x86/intel-iommu.rst} (100%)
rename Documentation/{intel_txt.txt => x86/intel_txt.rst} (100%)Signature · 1 line
2.21.0
PATCH 2/39 docs: rapidio: add it to the driver API
This is actually a subsystem description, with contains both kAPI and uAPI.
While it should ideally be slplit, let's place it at driver-api, as most things are related to kAPI and driver-specific info.
---
Documentation/admin-guide/index.rst | 1 +
Documentation/{driver-api => admin-guide}/rapidio.rst | 0
Documentation/driver-api/index.rst | 2 +-
Documentation/{ => driver-api}/rapidio/index.rst | 2 --
Documentation/{ => driver-api}/rapidio/mport_cdev.rst | 0
Documentation/{ => driver-api}/rapidio/rapidio.rst | 0
Documentation/{ => driver-api}/rapidio/rio_cm.rst | 0
Documentation/{ => driver-api}/rapidio/sysfs.rst | 0
Documentation/{ => driver-api}/rapidio/tsi721.rst | 0
drivers/rapidio/Kconfig | 2 +-
10 files changed, 3 insertions(+), 4 deletions(-)
rename Documentation/{driver-api => admin-guide}/rapidio.rst (100%)
rename Documentation/{ => driver-api}/rapidio/index.rst (94%)
rename Documentation/{ => driver-api}/rapidio/mport_cdev.rst (100%)
rename Documentation/{ => driver-api}/rapidio/rapidio.rst (100%)
rename Documentation/{ => driver-api}/rapidio/rio_cm.rst (100%)
rename Documentation/{ => driver-api}/rapidio/sysfs.rst (100%)
rename Documentation/{ => driver-api}/rapidio/tsi721.rst (100%)Documentation/admin-guide/index.rst +1 -0
@@ -61,6 +61,7 @@ configure specific aspects of kernel behavior to your liking. parport md module-signing + rapidio sysrq unicode vga-softcursor
Documentation/admin-guide/rapidio.rst renamed from Documentation/driver-api/rapidio.rst +0 -0
Documentation/driver-api/index.rst +1 -1
@@ -44,7 +44,7 @@ available subsections can be seen below. miscellaneous mei/index w1 - rapidio + rapidio/index s390-drivers vme 80211/index
Documentation/driver-api/rapidio/index.rst renamed from Documentation/rapidio/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =========================== The Linux RapidIO Subsystem ===========================
Documentation/driver-api/rapidio/mport_cdev.rst renamed from Documentation/rapidio/mport_cdev.rst +0 -0
Documentation/driver-api/rapidio/rapidio.rst renamed from Documentation/rapidio/rapidio.rst +0 -0
Documentation/driver-api/rapidio/rio_cm.rst renamed from Documentation/rapidio/rio_cm.rst +0 -0
Documentation/driver-api/rapidio/sysfs.rst renamed from Documentation/rapidio/sysfs.rst +0 -0
Documentation/driver-api/rapidio/tsi721.rst renamed from Documentation/rapidio/tsi721.rst +0 -0
drivers/rapidio/Kconfig +1 -1
@@ -86,7 +86,7 @@ config RAPIDIO_CHMAN This option includes RapidIO channelized messaging driver which provides socket-like interface to allow sharing of single RapidIO messaging mailbox between multiple user-space applications. - See "Documentation/rapidio/rio_cm.rst" for driver description. + See "Documentation/driver-api/rapidio/rio_cm.rst" for driver description. config RAPIDIO_MPORT_CDEV tristate "RapidIO /dev mport device driver"
Signature · 1 line
2.21.0
PATCH 23/39 docs: lp855x-driver.rst: add it to the driver-api book
In reply to Mauro Carvalho ChehabThe content of this file is intended for backlight Kernel developers.
---
Documentation/{ => driver-api}/backlight/lp855x-driver.rst | 2 --
Documentation/driver-api/index.rst | 1 +
MAINTAINERS | 2 +-
3 files changed, 2 insertions(+), 3 deletions(-)
rename Documentation/{ => driver-api}/backlight/lp855x-driver.rst (99%)Documentation/driver-api/backlight/lp855x-driver.rst renamed from Documentation/backlight/lp855x-driver.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ==================== Kernel driver lp855x ====================
Documentation/driver-api/index.rst +1 -0
@@ -66,6 +66,7 @@ available subsections can be seen below. thermal/index fpga/index acpi/index + backlight/lp855x-driver.rst generic-counter .. only:: subproject and html
MAINTAINERS +1 -1
@@ -15906,7 +15906,7 @@ F: sound/soc/codecs/isabelle* TI LP855x BACKLIGHT DRIVER M: Milo Kim <[email protected]> S: Maintained -F: Documentation/backlight/lp855x-driver.rst +F: Documentation/driver-api/backlight/lp855x-driver.rst F: drivers/video/backlight/lp855x_bl.c F: include/linux/platform_data/lp855x.h
Signature · 1 line
2.21.0
PATCH 25/39 docs: add some documentation dirs to the driver-api book
In reply to Mauro Carvalho ChehabThose are subsystem docs, with a mix of kABI and user-faced docs. While they're not split, keep the dirs where they are, adding just a pointer to the main index.
--- Documentation/accounting/index.rst | 2 +- Documentation/block/index.rst | 2 +- Documentation/hid/index.rst | 2 +- Documentation/iio/index.rst | 2 +- Documentation/index.rst | 4 ++++ 5 files changed, 8 insertions(+), 4 deletions(-)
Documentation/accounting/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ========== Accounting
Documentation/block/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ===== Block
Documentation/hid/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ============================= Human Interface Devices (HID)
Documentation/iio/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ============== Industrial I/O
Documentation/index.rst +4 -0
@@ -92,6 +92,10 @@ needed). driver-api/index core-api/index + accounting/index + block/index + hid/index + iio/index leds/index media/index networking/index
Signature · 1 line
2.21.0
PATCH 16/39 docs: admin-guide: move sysctl directory to it
In reply to Mauro Carvalho ChehabThe stuff under sysctl describes /sys interface from userspace point of view. So, add it to the admin-guide and remove the :orphan: from its index file.
---
CREDITS | 2 +-
Documentation/admin-guide/index.rst | 1 +
Documentation/admin-guide/kernel-parameters.txt | 2 +-
Documentation/admin-guide/mm/index.rst | 2 +-
Documentation/admin-guide/mm/ksm.rst | 2 +-
Documentation/{ => admin-guide}/sysctl/abi.rst | 0
Documentation/{ => admin-guide}/sysctl/fs.rst | 0
Documentation/{ => admin-guide}/sysctl/index.rst | 2 --
Documentation/{ => admin-guide}/sysctl/kernel.rst | 0
Documentation/{ => admin-guide}/sysctl/net.rst | 0
Documentation/{ => admin-guide}/sysctl/sunrpc.rst | 0
Documentation/{ => admin-guide}/sysctl/user.rst | 0
Documentation/{ => admin-guide}/sysctl/vm.rst | 0
Documentation/core-api/printk-formats.rst | 2 +-
Documentation/filesystems/proc.txt | 2 +-
Documentation/networking/ip-sysctl.txt | 2 +-
Documentation/vm/unevictable-lru.rst | 2 +-
fs/proc/Kconfig | 2 +-
kernel/panic.c | 2 +-
mm/swap.c | 2 +-
20 files changed, 12 insertions(+), 13 deletions(-)
rename Documentation/{ => admin-guide}/sysctl/abi.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/fs.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/index.rst (99%)
rename Documentation/{ => admin-guide}/sysctl/kernel.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/net.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/sunrpc.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/user.rst (100%)
rename Documentation/{ => admin-guide}/sysctl/vm.rst (100%)CREDITS +1 -1
@@ -3120,7 +3120,7 @@ S: France N: Rik van Riel E: [email protected] W: http://www.surriel.com/ -D: Linux-MM site, Documentation/sysctl/*, swap/mm readaround +D: Linux-MM site, Documentation/admin-guide/sysctl/*, swap/mm readaround D: kswapd fixes, random kernel hacker, rmap VM, D: nl.linux.org administrator, minor scheduler additions S: Red Hat Boston
Documentation/admin-guide/index.rst +1 -0
@@ -16,6 +16,7 @@ etc. README kernel-parameters devices + sysctl/index This section describes CPU vulnerabilities and their mitigations.
Documentation/admin-guide/kernel-parameters.txt +1 -1
@@ -3170,7 +3170,7 @@ numa_zonelist_order= [KNL, BOOT] Select zonelist order for NUMA. 'node', 'default' can be specified This can be set from sysctl after boot. - See Documentation/sysctl/vm.rst for details. + See Documentation/admin-guide/sysctl/vm.rst for details. ohci1394_dma=early [HW] enable debugging via the ohci1394 driver. See Documentation/debugging-via-ohci1394.txt for more
Documentation/admin-guide/mm/index.rst +1 -1
@@ -11,7 +11,7 @@ processes address space and many other cool things. Linux memory management is a complex system with many configurable settings. Most of these settings are available via ``/proc`` filesystem and can be quired and adjusted using ``sysctl``. These APIs -are described in Documentation/sysctl/vm.rst and in `man 5 proc`_. +are described in Documentation/admin-guide/sysctl/vm.rst and in `man 5 proc`_. .. _man 5 proc: http://man7.org/linux/man-pages/man5/proc.5.html
Documentation/admin-guide/mm/ksm.rst +1 -1
@@ -59,7 +59,7 @@ MADV_UNMERGEABLE is applied to a range which was never MADV_MERGEABLE. If a region of memory must be split into at least one new MADV_MERGEABLE or MADV_UNMERGEABLE region, the madvise may return ENOMEM if the process -will exceed ``vm.max_map_count`` (see Documentation/sysctl/vm.rst). +will exceed ``vm.max_map_count`` (see Documentation/admin-guide/sysctl/vm.rst). Like other madvise calls, they are intended for use on mapped areas of the user address space: they will report ENOMEM if the specified range
Documentation/admin-guide/sysctl/abi.rst renamed from Documentation/sysctl/abi.rst +0 -0
Documentation/admin-guide/sysctl/fs.rst renamed from Documentation/sysctl/fs.rst +0 -0
Documentation/admin-guide/sysctl/index.rst renamed from Documentation/sysctl/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =========================== Documentation for /proc/sys ===========================
Documentation/admin-guide/sysctl/kernel.rst renamed from Documentation/sysctl/kernel.rst +0 -0
Documentation/admin-guide/sysctl/net.rst renamed from Documentation/sysctl/net.rst +0 -0
Documentation/admin-guide/sysctl/sunrpc.rst renamed from Documentation/sysctl/sunrpc.rst +0 -0
Documentation/admin-guide/sysctl/user.rst renamed from Documentation/sysctl/user.rst +0 -0
Documentation/admin-guide/sysctl/vm.rst renamed from Documentation/sysctl/vm.rst +0 -0
Documentation/core-api/printk-formats.rst +1 -1
@@ -119,7 +119,7 @@ Kernel Pointers For printing kernel pointers which should be hidden from unprivileged users. The behaviour of %pK depends on the kptr_restrict sysctl - see -Documentation/sysctl/kernel.rst for more details. +Documentation/admin-guide/sysctl/kernel.rst for more details. Unmodified Addresses --------------------
Documentation/filesystems/proc.txt +1 -1
@@ -1479,7 +1479,7 @@ review the kernel documentation in the directory /usr/src/linux/Documentation. This chapter is heavily based on the documentation included in the pre 2.2 kernels, and became part of it in version 2.2.1 of the Linux kernel. -Please see: Documentation/sysctl/ directory for descriptions of these +Please see: Documentation/admin-guide/sysctl/ directory for descriptions of these entries. ------------------------------------------------------------------------------
Documentation/networking/ip-sysctl.txt +1 -1
@@ -2284,7 +2284,7 @@ addr_scope_policy - INTEGER /proc/sys/net/core/* - Please see: Documentation/sysctl/net.rst for descriptions of these entries. + Please see: Documentation/admin-guide/sysctl/net.rst for descriptions of these entries. /proc/sys/net/unix/*
Documentation/vm/unevictable-lru.rst +1 -1
@@ -439,7 +439,7 @@ Compacting MLOCKED Pages The unevictable LRU can be scanned for compactable regions and the default behavior is to do so. /proc/sys/vm/compact_unevictable_allowed controls -this behavior (see Documentation/sysctl/vm.rst). Once scanning of the +this behavior (see Documentation/admin-guide/sysctl/vm.rst). Once scanning of the unevictable LRU is enabled, the work of compaction is mostly handled by the page migration code and the same work flow as described in MIGRATING MLOCKED PAGES will apply.
fs/proc/Kconfig +1 -1
@@ -73,7 +73,7 @@ config PROC_SYSCTL interface is through /proc/sys. If you say Y here a tree of modifiable sysctl entries will be generated beneath the /proc/sys directory. They are explained in the files - in <file:Documentation/sysctl/>. Note that enabling this + in <file:Documentation/admin-guide/sysctl/>. Note that enabling this option will enlarge the kernel by at least 8 KB. As it is generally a good thing, you should say Y here unless
kernel/panic.c +1 -1
@@ -372,7 +372,7 @@ const struct taint_flag taint_flags[TAINT_FLAGS_COUNT] = {/** * print_tainted - return a string to represent the kernel taint state. * -* For individual taint flag meanings, see Documentation/sysctl/kernel.rst +* For individual taint flag meanings, see Documentation/admin-guide/sysctl/kernel.rst * * The string is overwritten by the next call to print_tainted(), * but is always NULL terminated.
mm/swap.c +1 -1
@@ -8,7 +8,7 @@/* * This file contains the default values for the operation of the * Linux VM subsystem. Fine-tuning documentation can be found in -* Documentation/sysctl/vm.rst. +* Documentation/admin-guide/sysctl/vm.rst. * Started 18.12.91 * Swap aging added 23.2.95, Stephen Tweedie. * Buffermem limits added 12.3.98, Rik van Riel.
Signature · 1 line
2.21.0
PATCH 8/39 docs: mmc: move it to the driver-api
In reply to Mauro Carvalho ChehabMost of the stuff here is related to the kAPI.
---
Documentation/driver-api/index.rst | 1 +
Documentation/{ => driver-api}/mmc/index.rst | 2 --
Documentation/{ => driver-api}/mmc/mmc-async-req.rst | 0
Documentation/{ => driver-api}/mmc/mmc-dev-attrs.rst | 0
Documentation/{ => driver-api}/mmc/mmc-dev-parts.rst | 0
Documentation/{ => driver-api}/mmc/mmc-tools.rst | 0
6 files changed, 1 insertion(+), 2 deletions(-)
rename Documentation/{ => driver-api}/mmc/index.rst (94%)
rename Documentation/{ => driver-api}/mmc/mmc-async-req.rst (100%)
rename Documentation/{ => driver-api}/mmc/mmc-dev-attrs.rst (100%)
rename Documentation/{ => driver-api}/mmc/mmc-dev-parts.rst (100%)
rename Documentation/{ => driver-api}/mmc/mmc-tools.rst (100%)Documentation/driver-api/index.rst +1 -0
@@ -44,6 +44,7 @@ available subsections can be seen below. miscellaneous mei/index mtd/index + mmc/index nvdimm/index w1 rapidio/index
Documentation/driver-api/mmc/index.rst renamed from Documentation/mmc/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ======================== MMC/SD/SDIO card support ========================
Documentation/driver-api/mmc/mmc-async-req.rst renamed from Documentation/mmc/mmc-async-req.rst +0 -0
Documentation/driver-api/mmc/mmc-dev-attrs.rst renamed from Documentation/mmc/mmc-dev-attrs.rst +0 -0
Documentation/driver-api/mmc/mmc-dev-parts.rst renamed from Documentation/mmc/mmc-dev-parts.rst +0 -0
Documentation/driver-api/mmc/mmc-tools.rst renamed from Documentation/mmc/mmc-tools.rst +0 -0
Signature · 1 line
2.21.0
PATCH 5/39 docs: namespace: move it to the admin-guide
In reply to Mauro Carvalho ChehabAs stated at the documentation, this is meant to be for users to better understand namespaces.
---
Documentation/admin-guide/index.rst | 1 +
.../{ => admin-guide}/namespaces/compatibility-list.rst | 0
Documentation/{ => admin-guide}/namespaces/index.rst | 2 --
Documentation/{ => admin-guide}/namespaces/resource-control.rst | 0
4 files changed, 1 insertion(+), 2 deletions(-)
rename Documentation/{ => admin-guide}/namespaces/compatibility-list.rst (100%)
rename Documentation/{ => admin-guide}/namespaces/index.rst (91%)
rename Documentation/{ => admin-guide}/namespaces/resource-control.rst (100%)Documentation/admin-guide/index.rst +1 -0
@@ -76,6 +76,7 @@ configure specific aspects of kernel behavior to your liking. thunderbolt LSM/index mm/index + namespaces/index perf-security acpi/index
Documentation/admin-guide/namespaces/compatibility-list.rst renamed from Documentation/namespaces/compatibility-list.rst +0 -0
Documentation/admin-guide/namespaces/index.rst renamed from Documentation/namespaces/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ========== Namespaces ==========
Documentation/admin-guide/namespaces/resource-control.rst renamed from Documentation/namespaces/resource-control.rst +0 -0
Signature · 1 line
2.21.0
PATCH 9/39 docs: md: move it to the driver-api book
In reply to Mauro Carvalho ChehabThe docs there were meant to be read by a Kernel developer.
---
Documentation/driver-api/index.rst | 1 +
Documentation/{ => driver-api}/md/index.rst | 2 --
Documentation/{ => driver-api}/md/md-cluster.rst | 0
Documentation/{ => driver-api}/md/raid5-cache.rst | 0
Documentation/{ => driver-api}/md/raid5-ppl.rst | 0
5 files changed, 1 insertion(+), 2 deletions(-)
rename Documentation/{ => driver-api}/md/index.rst (89%)
rename Documentation/{ => driver-api}/md/md-cluster.rst (100%)
rename Documentation/{ => driver-api}/md/raid5-cache.rst (100%)
rename Documentation/{ => driver-api}/md/raid5-ppl.rst (100%)Documentation/driver-api/index.rst +1 -0
@@ -55,6 +55,7 @@ available subsections can be seen below. firmware/index pinctl gpio/index + md/index misc_devices nfc/index dmaengine/index
Documentation/driver-api/md/index.rst renamed from Documentation/md/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ==== RAID ====
Documentation/driver-api/md/md-cluster.rst renamed from Documentation/md/md-cluster.rst +0 -0
Documentation/driver-api/md/raid5-cache.rst renamed from Documentation/md/raid5-cache.rst +0 -0
Documentation/driver-api/md/raid5-ppl.rst renamed from Documentation/md/raid5-ppl.rst +0 -0
Signature · 1 line
2.21.0
PATCH 11/39 docs: ioctl: add it to the uAPI guide
In reply to Mauro Carvalho ChehabWhile 100% of its contents is userspace, let's keep the dir at the same place, as this is a well-known location.
--- Documentation/index.rst | 1 + Documentation/ioctl/index.rst | 2 +- Documentation/ioctl/ioctl-number.rst | 2 -- 3 files changed, 2 insertions(+), 3 deletions(-)
Documentation/index.rst +1 -0
@@ -56,6 +56,7 @@ the kernel interface as seen by application developers. :maxdepth: 2 userspace-api/index + ioctl/index Introduction to kernel development
Documentation/ioctl/index.rst +1 -1
@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ====== IOCTLs
Documentation/ioctl/ioctl-number.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============= Ioctl Numbers =============
Signature · 1 line
2.21.0
PATCH 7/39 docs: nfc: add it to the driver-api book
In reply to Mauro Carvalho ChehabMost of the descriptions here are oriented to a Kernel developer.
---
Documentation/driver-api/index.rst | 1 +
Documentation/{ => driver-api}/nfc/index.rst | 2 --
Documentation/{ => driver-api}/nfc/nfc-hci.rst | 0
Documentation/{ => driver-api}/nfc/nfc-pn544.rst | 0
4 files changed, 1 insertion(+), 2 deletions(-)
rename Documentation/{ => driver-api}/nfc/index.rst (92%)
rename Documentation/{ => driver-api}/nfc/nfc-hci.rst (100%)
rename Documentation/{ => driver-api}/nfc/nfc-pn544.rst (100%)Documentation/driver-api/index.rst +1 -0
@@ -55,6 +55,7 @@ available subsections can be seen below. pinctl gpio/index misc_devices + nfc/index dmaengine/index slimbus soundwire/index
Documentation/driver-api/nfc/index.rst renamed from Documentation/nfc/index.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ======================== Near Field Communication ========================
Documentation/driver-api/nfc/nfc-hci.rst renamed from Documentation/nfc/nfc-hci.rst +0 -0
Documentation/driver-api/nfc/nfc-pn544.rst renamed from Documentation/nfc/nfc-pn544.rst +0 -0
Signature · 1 line
2.21.0
PATCH 12/39 docs: interconnect.rst: add it to the driver-api guide
In reply to Mauro Carvalho ChehabThis is intented for Kernel hackers audience.
---
Documentation/driver-api/index.rst | 1 +
Documentation/{interconnect => driver-api}/interconnect.rst | 2 --
MAINTAINERS | 2 +-
3 files changed, 2 insertions(+), 3 deletions(-)
rename Documentation/{interconnect => driver-api}/interconnect.rst (99%)Documentation/driver-api/index.rst +1 -0
@@ -35,6 +35,7 @@ available subsections can be seen below. spi i2c i3c/index + interconnect hsi edac scsi
Documentation/driver-api/interconnect.rst renamed from Documentation/interconnect/interconnect.rst +0 -2
@@ -1,7 +1,5 @@ .. SPDX-License-Identifier: GPL-2.0 -:orphan: - ===================================== GENERIC SYSTEM INTERCONNECT SUBSYSTEM =====================================
MAINTAINERS +1 -1
@@ -8273,7 +8273,7 @@ INTERCONNECT API M: Georgi Djakov <[email protected]> L: [email protected] S: Maintained -F: Documentation/interconnect/ +F: Documentation/driver-api/interconnect.rst F: Documentation/devicetree/bindings/interconnect/ F: drivers/interconnect/ F: include/dt-bindings/interconnect/
Signature · 1 line
2.21.0
Re: [PATCH 28/39] docs: admin-guide: add a series of orphaned documents
In reply to Mauro Carvalho ChehabQuoted 6 lines · Mauro Carvalho Chehab
There are lots of documents that belong to the admin-guide but are on random places (most under Documentation root dir).
Move them to the admin guide.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
Quoted 534 lines
--- Documentation/ABI/stable/sysfs-devices-node | 2 +- Documentation/ABI/testing/procfs-diskstats | 2 +- Documentation/ABI/testing/sysfs-block | 2 +- .../ABI/testing/sysfs-devices-system-cpu | 4 ++-- .../{btmrvl.txt => admin-guide/btmrvl.rst} | 0 .../clearing-warn-once.rst} | 0 .../{cpu-load.txt => admin-guide/cpu-load.rst} | 0 .../cputopology.rst} | 0 .../admin-guide/device-mapper/statistics.rst | 4 ++-- .../{efi-stub.txt => admin-guide/efi-stub.rst} | 0 .../{highuid.txt => admin-guide/highuid.rst} | 0 Documentation/admin-guide/hw-vuln/l1tf.rst | 2 +- .../hw_random.rst} | 0 Documentation/admin-guide/index.rst | 17 +++++++++++++++++ .../{iostats.txt => admin-guide/iostats.rst} | 0 Documentation/admin-guide/kernel-parameters.txt | 2 +- .../kernel-per-CPU-kthreads.rst} | 0 .../lcd-panel-cgram.rst | 2 -- Documentation/{ldm.txt => admin-guide/ldm.rst} | 0 .../lockup-watchdogs.rst} | 0 .../mm/cma_debugfs.rst} | 2 -- Documentation/admin-guide/mm/index.rst | 1 + .../{numastat.txt => admin-guide/numastat.rst} | 0 Documentation/{pnp.txt => admin-guide/pnp.rst} | 0 Documentation/{rtc.txt => admin-guide/rtc.rst} | 0 .../{svga.txt => admin-guide/svga.rst} | 0 Documentation/admin-guide/sysctl/kernel.rst | 2 +- .../video-output.rst} | 0 Documentation/fb/vesafb.rst | 2 +- Documentation/x86/topology.rst | 2 +- MAINTAINERS | 12 ++++++------ arch/arm/Kconfig | 2 +- arch/parisc/Kconfig | 2 +- arch/sh/Kconfig | 2 +- arch/sparc/Kconfig | 2 +- arch/x86/Kconfig | 4 ++-- block/partitions/Kconfig | 2 +- drivers/char/Kconfig | 4 ++-- drivers/char/hw_random/core.c | 2 +- include/linux/hw_random.h | 2 +- 40 files changed, 47 insertions(+), 33 deletions(-) rename Documentation/{btmrvl.txt => admin-guide/btmrvl.rst} (100%) rename Documentation/{clearing-warn-once.txt => admin-guide/clearing-warn-once.rst} (100%) rename Documentation/{cpu-load.txt => admin-guide/cpu-load.rst} (100%) rename Documentation/{cputopology.txt => admin-guide/cputopology.rst} (100%) rename Documentation/{efi-stub.txt => admin-guide/efi-stub.rst} (100%) rename Documentation/{highuid.txt => admin-guide/highuid.rst} (100%) rename Documentation/{hw_random.txt => admin-guide/hw_random.rst} (100%) rename Documentation/{iostats.txt => admin-guide/iostats.rst} (100%) rename Documentation/{kernel-per-CPU-kthreads.txt => admin-guide/kernel-per-CPU-kthreads.rst} (100%) rename Documentation/{auxdisplay => admin-guide}/lcd-panel-cgram.rst (99%) rename Documentation/{ldm.txt => admin-guide/ldm.rst} (100%) rename Documentation/{lockup-watchdogs.txt => admin-guide/lockup-watchdogs.rst} (100%) rename Documentation/{cma/debugfs.rst => admin-guide/mm/cma_debugfs.rst} (98%) rename Documentation/{numastat.txt => admin-guide/numastat.rst} (100%) rename Documentation/{pnp.txt => admin-guide/pnp.rst} (100%) rename Documentation/{rtc.txt => admin-guide/rtc.rst} (100%) rename Documentation/{svga.txt => admin-guide/svga.rst} (100%) rename Documentation/{video-output.txt => admin-guide/video-output.rst} (100%)Documentation/ABI/stable/sysfs-devices-node +1
-1@@ -61,7 +61,7 @@ Date: October 2002 Contact: Linux Memory Management list <[email protected]> Description: The node's hit/miss statistics, in units of pages. - See Documentation/numastat.txt + See Documentation/admin-guide/numastat.rst What: /sys/devices/system/node/nodeX/distance Date: October 2002Documentation/ABI/testing/procfs-diskstats +1
-1@@ -29,4 +29,4 @@ Description: 17 - sectors discarded 18 - time spent discarding - For more details refer to Documentation/iostats.txt + For more details refer to Documentation/admin-guide/iostats.rstDocumentation/ABI/testing/sysfs-block +1
-1@@ -15,7 +15,7 @@ Description: 9 - I/Os currently in progress 10 - time spent doing I/Os (ms) 11 - weighted time spent doing I/Os (ms) - For more details refer Documentation/iostats.txt + For more details refer Documentation/admin-guide/iostats.rst What: /sys/block/<disk>/<part>/statDocumentation/ABI/testing/sysfs-devices-system-cpu +2
-2@@ -34,7 +34,7 @@ Description: CPU topology files that describe kernel limits related to present: cpus that have been identified as being present in the system. - See Documentation/cputopology.txt for more information. + See Documentation/admin-guide/cputopology.rst for more information. What: /sys/devices/system/cpu/probe@@ -103,7 +103,7 @@ Description: CPU topology files that describe a logical CPU's relationship thread_siblings_list: human-readable list of cpu#'s hardware threads within the same core as cpu# - See Documentation/cputopology.txt for more information. + See Documentation/admin-guide/cputopology.rst for more information. What: /sys/devices/system/cpu/cpuidle/current_driverDocumentation/admin-guide/btmrvl.rst renamed from Documentation/btmrvl.txt +0
-0Documentation/admin-guide/clearing-warn-once.rst renamed from Documentation/clearing-warn-once.txt +0
-0Documentation/admin-guide/cpu-load.rst renamed from Documentation/cpu-load.txt +0
-0Documentation/admin-guide/cputopology.rst renamed from Documentation/cputopology.txt +0
-0Documentation/admin-guide/device-mapper/statistics.rst +2
-2@@ -13,7 +13,7 @@ the range specified. The I/O statistics counters for each step-sized area of a region are in the same format as `/sys/block/*/stat` or `/proc/diskstats` (see: -Documentation/iostats.txt). But two extra counters (12 and 13) are +Documentation/admin-guide/iostats.rst). But two extra counters (12 and 13) are provided: total time spent reading and writing. When the histogram argument is used, the 14th parameter is reported that represents the histogram of latencies. All these counters may be accessed by sending@@ -151,7 +151,7 @@ Messages The first 11 counters have the same meaning as `/sys/block/*/stat or /proc/diskstats`. - Please refer to Documentation/iostats.txt for details. + Please refer to Documentation/admin-guide/iostats.rst for details. 1. the number of reads completed 2. the number of reads mergedDocumentation/admin-guide/efi-stub.rst renamed from Documentation/efi-stub.txt +0
-0Documentation/admin-guide/highuid.rst renamed from Documentation/highuid.txt +0
-0Documentation/admin-guide/hw-vuln/l1tf.rst +1
-1@@ -241,7 +241,7 @@ Guest mitigation mechanisms For further information about confining guests to a single or to a group of cores consult the cpusets documentation: - https://www.kernel.org/doc/Documentation/cgroup-v1/cpusets.rst + https://www.kernel.org/doc/Documentation/admin-guide/cgroup-v1/cpusets.rst .. _interrupt_isolation:Documentation/admin-guide/hw_random.rst renamed from Documentation/hw_random.txt +0
-0Documentation/admin-guide/index.rst +17
-0@@ -84,8 +84,25 @@ configure specific aspects of kernel behavior to your liking. perf-security acpi/index aoe/index + btmrvl + clearing-warn-once + cpu-load + cputopology device-mapper/index + efi-stub + highuid + hw_random + iostats + kernel-per-CPU-kthreads laptops/index + lcd-panel-cgram + ldm + lockup-watchdogs + numastat + pnp + rtc + svga + video-output .. only:: subproject and htmlDocumentation/admin-guide/iostats.rst renamed from Documentation/iostats.txt +0
-0Documentation/admin-guide/kernel-parameters.txt +1
-1@@ -5092,7 +5092,7 @@ vga= [BOOT,X86-32] Select a particular video mode See Documentation/x86/boot.rst and - Documentation/svga.txt. + Documentation/admin-guide/svga.rst. Use vga=ask for menu. This is actually a boot loader parameter; the value is passed to the kernel using a special protocol.Documentation/admin-guide/kernel-per-CPU-kthreads.rst renamed from Documentation/kernel-per-CPU-kthreads.txt +0
-0Documentation/admin-guide/lcd-panel-cgram.rst renamed from Documentation/auxdisplay/lcd-panel-cgram.rst +0
-2@@ -1,5 +1,3 @@ -:orphan: - ====================================== Parallel port LCD/Keypad Panel support ======================================Documentation/admin-guide/ldm.rst renamed from Documentation/ldm.txt +0
-0Documentation/admin-guide/lockup-watchdogs.rst renamed from Documentation/lockup-watchdogs.txt +0
-0Documentation/admin-guide/mm/cma_debugfs.rst renamed from Documentation/cma/debugfs.rst +0
-2@@ -1,5 +1,3 @@ -:orphan: - ===================== CMA Debugfs Interface =====================Documentation/admin-guide/mm/index.rst +1
-0@@ -26,6 +26,7 @@ the Linux memory management. :maxdepth: 1 concepts + cma_debugfs hugetlbpage idle_page_tracking ksmDocumentation/admin-guide/numastat.rst renamed from Documentation/numastat.txt +0
-0Documentation/admin-guide/pnp.rst renamed from Documentation/pnp.txt +0
-0Documentation/admin-guide/rtc.rst renamed from Documentation/rtc.txt +0
-0Documentation/admin-guide/svga.rst renamed from Documentation/svga.txt +0
-0Documentation/admin-guide/sysctl/kernel.rst +1
-1@@ -327,7 +327,7 @@ when a hard lockup is detected. 0 - don't panic on hard lockup 1 - panic on hard lockup -See Documentation/lockup-watchdogs.txt for more information. This can +See Documentation/admin-guide/lockup-watchdogs.rst for more information. This can also be set using the nmi_watchdog kernel parameter.Documentation/admin-guide/video-output.rst renamed from Documentation/video-output.txt +0
-0Documentation/fb/vesafb.rst +1
-1@@ -30,7 +30,7 @@ How to use it? ============== Switching modes is done using the vga=... boot parameter. Read -Documentation/svga.txt for details. +Documentation/admin-guide/svga.rst for details. You should compile in both vgacon (for text mode) and vesafb (for graphics mode). Which of them takes over the console depends onDocumentation/x86/topology.rst +1
-1@@ -9,7 +9,7 @@ representation in the kernel. Update/change when doing changes to the respective code. The architecture-agnostic topology definitions are in -Documentation/cputopology.txt. This file holds x86-specific +Documentation/admin-guide/cputopology.rst. This file holds x86-specific differences/specialities which must not necessarily apply to the generic definitions. Thus, the way to read up on Linux topology on x86 is to start with the generic one and look at this one in parallel for the x86 specifics.MAINTAINERS +6
-6@@ -6054,7 +6054,7 @@ M: Ard Biesheuvel <[email protected]> L: [email protected] T: git git://git.kernel.org/pub/scm/linux/kernel/git/efi/efi.git S: Maintained -F: Documentation/efi-stub.txt +F: Documentation/admin-guide/efi-stub.rst F: arch/*/kernel/efi.c F: arch/x86/boot/compressed/eboot.[ch] F: arch/*/include/asm/efi.h@@ -7033,7 +7033,7 @@ M: Herbert Xu <[email protected]> L: [email protected] S: Odd fixes F: Documentation/devicetree/bindings/rng/ -F: Documentation/hw_random.txt +F: Documentation/admin-guide/hw_random.rst F: drivers/char/hw_random/ F: include/linux/hw_random.h@@ -9347,7 +9347,7 @@ M: "Richard Russon (FlatCap)" <[email protected]> L: [email protected] W: http://www.linux-ntfs.org/content/view/19/37/ S: Maintained -F: Documentation/ldm.txt +F: Documentation/admin-guide/ldm.rst F: block/partitions/ldm.* LSILOGIC MPT FUSION DRIVERS (FC/SAS/SPI)@@ -12000,7 +12000,7 @@ PARALLEL LCD/KEYPAD PANEL DRIVER M: Willy Tarreau <[email protected]> M: Ksenija Stanojevic <[email protected]> S: Odd Fixes -F: Documentation/auxdisplay/lcd-panel-cgram.rst +F: Documentation/admin-guide/lcd-panel-cgram.rst F: drivers/auxdisplay/panel.c PARALLEL PORT SUBSYSTEM@@ -13419,7 +13419,7 @@ Q: http://patchwork.ozlabs.org/project/rtc-linux/list/ T: git git://git.kernel.org/pub/scm/linux/kernel/git/abelloni/linux.git S: Maintained F: Documentation/devicetree/bindings/rtc/ -F: Documentation/rtc.txt +F: Documentation/admin-guide/rtc.rst F: drivers/rtc/ F: include/linux/rtc.h F: include/uapi/linux/rtc.h@@ -15248,7 +15248,7 @@ SVGA HANDLING M: Martin Mares <[email protected]> L: [email protected] S: Maintained -F: Documentation/svga.txt +F: Documentation/admin-guide/svga.rst F: arch/x86/boot/video* SWIOTLB SUBSYSTEMarch/arm/Kconfig +1
-1@@ -1286,7 +1286,7 @@ config SMP will run faster if you say N here. See also <file:Documentation/x86/i386/IO-APIC.rst>, - <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO available at + <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO available at <http://tldp.org/HOWTO/SMP-HOWTO.html>. If you don't know what to do here, say N.arch/parisc/Kconfig +1
-1@@ -277,7 +277,7 @@ config SMP machines, but will use only one CPU of a multiprocessor machine. On a uniprocessor machine, the kernel will run faster if you say N. - See also <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO + See also <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO available at <http://www.tldp.org/docs.html#howto>. If you don't know what to do here, say N.arch/sh/Kconfig +1
-1@@ -679,7 +679,7 @@ config SMP People using multiprocessor machines who say Y here should also say Y to "Enhanced Real Time Clock Support", below. - See also <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO + See also <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO available at <http://www.tldp.org/docs.html#howto>. If you don't know what to do here, say N.arch/sparc/Kconfig +1
-1@@ -180,7 +180,7 @@ config SMP Y to "Enhanced Real Time Clock Support", below. The "Advanced Power Management" code will be disabled if you say Y here. - See also <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO + See also <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO available at <http://www.tldp.org/docs.html#howto>. If you don't know what to do here, say N.arch/x86/Kconfig +2
-2@@ -402,7 +402,7 @@ config SMP Management" code will be disabled if you say Y here. See also <file:Documentation/x86/i386/IO-APIC.rst>, - <file:Documentation/lockup-watchdogs.txt> and the SMP-HOWTO available at + <file:Documentation/admin-guide/lockup-watchdogs.rst> and the SMP-HOWTO available at <http://www.tldp.org/docs.html#howto>. If you don't know what to do here, say N.@@ -1959,7 +1959,7 @@ config EFI_STUB This kernel feature allows a bzImage to be loaded directly by EFI firmware without the use of a bootloader. - See Documentation/efi-stub.txt for more information. + See Documentation/admin-guide/efi-stub.rst for more information. config EFI_MIXED bool "EFI mixed-mode support"block/partitions/Kconfig +1
-1@@ -194,7 +194,7 @@ config LDM_PARTITION Normal partitions are now called Basic Disks under Windows 2000, XP, and Vista. - For a fuller description read <file:Documentation/ldm.txt>. + For a fuller description read <file:Documentation/admin-guide/ldm.rst>. If unsure, say N.drivers/char/Kconfig +2
-2@@ -291,7 +291,7 @@ config RTC and set the RTC in an SMP compatible fashion. If you think you have a use for such a device (such as periodic data - sampling), then say Y here, and read <file:Documentation/rtc.txt> + sampling), then say Y here, and read <file:Documentation/admin-guide/rtc.rst> for details. To compile this driver as a module, choose M here: the@@ -313,7 +313,7 @@ config JS_RTC /dev/rtc. If you think you have a use for such a device (such as periodic data - sampling), then say Y here, and read <file:Documentation/rtc.txt> + sampling), then say Y here, and read <file:Documentation/admin-guide/rtc.rst> for details. To compile this driver as a module, choose M here: thedrivers/char/hw_random/core.c +1
-1@@ -4,7 +4,7 @@* Copyright 2006 Michael Buesch <[email protected]> * Copyright 2005 (c) MontaVista Software, Inc. * -* Please read Documentation/hw_random.txt for details on use. +* Please read Documentation/admin-guide/hw_random.rst for details on use. * * This software may be used and distributed according to the terms * of the GNU General Public License, incorporated herein by reference. include/linux/hw_random.h +1
-1@@ -1,7 +1,7 @@/* Hardware Random Number Generator -Please read Documentation/hw_random.txt for details on use. +Please read Documentation/admin-guide/hw_random.rst for details on use. ---------------------------------------------------------- This software may be used and distributed according to the terms Signature · 1 line
2.21.0
Signature · 3 lines
Alexandre Belloni, Bootlin Embedded Linux and Kernel engineering https://bootlin.com
Re: [PATCH 28/39] docs: admin-guide: add a series of orphaned documents
In reply to Mauro Carvalho ChehabQuoted 6 lines · Mauro Carvalho Chehab
There are lots of documents that belong to the admin-guide but are on random places (most under Documentation root dir).
Move them to the admin guide.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
Quoted 52 lines
---
Documentation/ABI/stable/sysfs-devices-node | 2 +-
Documentation/ABI/testing/procfs-diskstats | 2 +-
Documentation/ABI/testing/sysfs-block | 2 +-
.../ABI/testing/sysfs-devices-system-cpu | 4 ++--
.../{btmrvl.txt => admin-guide/btmrvl.rst} | 0
.../clearing-warn-once.rst} | 0
.../{cpu-load.txt => admin-guide/cpu-load.rst} | 0
.../cputopology.rst} | 0
.../admin-guide/device-mapper/statistics.rst | 4 ++--
.../{efi-stub.txt => admin-guide/efi-stub.rst} | 0
.../{highuid.txt => admin-guide/highuid.rst} | 0
Documentation/admin-guide/hw-vuln/l1tf.rst | 2 +-
.../hw_random.rst} | 0
Documentation/admin-guide/index.rst | 17 +++++++++++++++++
.../{iostats.txt => admin-guide/iostats.rst} | 0
Documentation/admin-guide/kernel-parameters.txt | 2 +-
.../kernel-per-CPU-kthreads.rst} | 0
.../lcd-panel-cgram.rst | 2 --
Documentation/{ldm.txt => admin-guide/ldm.rst} | 0
.../lockup-watchdogs.rst} | 0
.../mm/cma_debugfs.rst} | 2 --
Documentation/admin-guide/mm/index.rst | 1 +
.../{numastat.txt => admin-guide/numastat.rst} | 0
Documentation/{pnp.txt => admin-guide/pnp.rst} | 0
Documentation/{rtc.txt => admin-guide/rtc.rst} | 0
.../{svga.txt => admin-guide/svga.rst} | 0
Documentation/admin-guide/sysctl/kernel.rst | 2 +-
.../video-output.rst} | 0
Documentation/fb/vesafb.rst | 2 +-
Documentation/x86/topology.rst | 2 +-
MAINTAINERS | 12 ++++++------
arch/arm/Kconfig | 2 +-
arch/parisc/Kconfig | 2 +-
arch/sh/Kconfig | 2 +-
arch/sparc/Kconfig | 2 +-
arch/x86/Kconfig | 4 ++--
block/partitions/Kconfig | 2 +-
drivers/char/Kconfig | 4 ++--
drivers/char/hw_random/core.c | 2 +-
include/linux/hw_random.h | 2 +-
40 files changed, 47 insertions(+), 33 deletions(-)
rename Documentation/{btmrvl.txt => admin-guide/btmrvl.rst} (100%)
rename Documentation/{clearing-warn-once.txt => admin-guide/clearing-warn-once.rst} (100%)
rename Documentation/{cpu-load.txt => admin-guide/cpu-load.rst} (100%)
rename Documentation/{cputopology.txt => admin-guide/cputopology.rst} (100%)
rename Documentation/{efi-stub.txt => admin-guide/efi-stub.rst} (100%)
rename Documentation/{highuid.txt => admin-guide/highuid.rst} (100%)
rename Documentation/{hw_random.txt => admin-guide/hw_random.rst} (100%)
rename Documentation/{iostats.txt => admin-guide/iostats.rst} (100%)
rename Documentation/{kernel-per-CPU-kthreads.txt => admin-guide/kernel-per-CPU-kthreads.rst} (100%)
rename Documentation/{auxdisplay => admin-guide}/lcd-panel-cgram.rst (99%)Quoted 8 lines
rename Documentation/{ldm.txt => admin-guide/ldm.rst} (100%)
rename Documentation/{lockup-watchdogs.txt => admin-guide/lockup-watchdogs.rst} (100%)
rename Documentation/{cma/debugfs.rst => admin-guide/mm/cma_debugfs.rst} (98%)
rename Documentation/{numastat.txt => admin-guide/numastat.rst} (100%)
rename Documentation/{pnp.txt => admin-guide/pnp.rst} (100%)
rename Documentation/{rtc.txt => admin-guide/rtc.rst} (100%)
rename Documentation/{svga.txt => admin-guide/svga.rst} (100%)
rename Documentation/{video-output.txt => admin-guide/video-output.rst} (100%)Best regards,
--
Bartlomiej Zolnierkiewicz
Samsung R&D Institute Poland
Samsung Electronics
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
Re: [PATCH 37/39] docs: adds some directories to the main documentation index
In reply to Mauro Carvalho ChehabQuoted 12 lines · Mauro Carvalho Chehab
The contents of those directories were orphaned at the documentation body.
While those directories could likely be moved to be inside some guide, I'm opting to just adding their indexes to the main one, removing the :orphan: and adding the SPDX header.
For the drivers, the rationale is that the documentation contains a mix of Kernelspace, uAPI and admin-guide. So, better to keep them on separate directories, as we've be doing with similar subsystem-specific docs that were not split yet.
Quoted 6 lines
For the others, well... I'm too lazy to do the move. Also, it seems to make sense to keep at least some of those at the main dir (like kbuild, for example). In any case, a latter patch could do the move.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
Quoted 8 lines
--- Documentation/cdrom/index.rst | 2 +- Documentation/fault-injection/index.rst | 2 +- Documentation/fb/index.rst | 2 +- Documentation/fpga/index.rst | 2 +- Documentation/ide/index.rst | 2 +- Documentation/index.rst | 14 ++++++++++++++ Documentation/kbuild/index.rst | 2 +-
Quoted 8 lines
Documentation/livepatch/index.rst | 2 +- Documentation/netlabel/index.rst | 2 +- Documentation/pcmcia/index.rst | 2 +- Documentation/power/index.rst | 2 +- Documentation/target/index.rst | 2 +- Documentation/timers/index.rst | 2 +- Documentation/watchdog/index.rst | 2 +- 14 files changed, 27 insertions(+), 13 deletions(-)
Best regards,
--
Bartlomiej Zolnierkiewicz
Samsung R&D Institute Poland
Samsung Electronics
Re: [PATCH 12/39] docs: interconnect.rst: add it to the driver-api guide
In reply to Mauro Carvalho ChehabQuoted 1 line · Mauro Carvalho Chehab
This is intented for Kernel hackers audience.
s/intented/intended/
Quoted 2 lines
Signed-off-by Mauro Carvalho Chehab <[email protected]>
Thanks!
Georgi
Quoted 48 lines
--- Documentation/driver-api/index.rst | 1 + Documentation/{interconnect => driver-api}/interconnect.rst | 2 -- MAINTAINERS | 2 +- 3 files changed, 2 insertions(+), 3 deletions(-) rename Documentation/{interconnect => driver-api}/interconnect.rst (99%)Documentation/driver-api/index.rst +1
-0@@ -35,6 +35,7 @@ available subsections can be seen below. spi i2c i3c/index + interconnect hsi edac scsiDocumentation/driver-api/interconnect.rst renamed from Documentation/interconnect/interconnect.rst +0
-2@@ -1,7 +1,5 @@ .. SPDX-License-Identifier: GPL-2.0 -:orphan: - ===================================== GENERIC SYSTEM INTERCONNECT SUBSYSTEM =====================================MAINTAINERS +1
-1@@ -8273,7 +8273,7 @@ INTERCONNECT API M: Georgi Djakov <[email protected]> L: [email protected] S: Maintained -F: Documentation/interconnect/ +F: Documentation/driver-api/interconnect.rst F: Documentation/devicetree/bindings/interconnect/ F: drivers/interconnect/ F: include/dt-bindings/interconnect/
Re: [PATCH 17/39] docs: admin-guide: add laptops documentation
In reply to Mauro Carvalho ChehabQuoted 4 lines · Mauro Carvalho Chehab
The docs under
Documentation/laptopscontain users specific information.
Quoted 217 lines
Signed-off-by Mauro Carvalho Chehab <[email protected]>--- 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%)Documentation/ABI/testing/sysfs-block-device +1
-1@@ -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_enableDocumentation/ABI/testing/sysfs-platform-asus-laptop +1
-1@@ -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 2007Documentation/admin-guide/index.rst +1
-0@@ -81,6 +81,7 @@ configure specific aspects of kernel behavior to your liking. perf-security acpi/index device-mapper/index + laptops/index .. only:: subproject and htmlDocumentation/admin-guide/kernel-parameters.txt +1
-1@@ -4373,7 +4373,7 @@ Format: <integer> 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.Documentation/admin-guide/laptops/asus-laptop.rst renamed from Documentation/laptops/asus-laptop.rst +0
-0Documentation/admin-guide/laptops/disk-shock-protection.rst renamed from Documentation/laptops/disk-shock-protection.rst +0
-0Documentation/admin-guide/laptops/index.rst renamed from Documentation/laptops/index.rst +0
-1@@ -1,4 +1,3 @@ -:orphan: ============== Laptop DriversDocumentation/admin-guide/laptops/laptop-mode.rst renamed from Documentation/laptops/laptop-mode.rst +0
-0Documentation/admin-guide/laptops/lg-laptop.rst renamed from Documentation/laptops/lg-laptop.rst +0
-1@@ -1,6 +1,5 @@ .. SPDX-License-Identifier: GPL-2.0+ -:orphan: LG Gram laptop extra features =============================Documentation/admin-guide/laptops/sony-laptop.rst renamed from Documentation/laptops/sony-laptop.rst +0
-0Documentation/admin-guide/laptops/sonypi.rst renamed from Documentation/laptops/sonypi.rst +0
-0Documentation/admin-guide/laptops/thinkpad-acpi.rst renamed from Documentation/laptops/thinkpad-acpi.rst +0
-0Documentation/admin-guide/laptops/toshiba_haps.rst renamed from Documentation/laptops/toshiba_haps.rst +0
-0Documentation/admin-guide/sysctl/vm.rst +2
-2@@ -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_layoutMAINTAINERS +2
-2@@ -8978,7 +8978,7 @@ M: Matan Ziv-Av <[email protected]> L: [email protected] 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@@ -14830,7 +14830,7 @@ M: Mattia Dongili <[email protected]> L: [email protected] 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.hdrivers/char/Kconfig +1
-1@@ -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 - <file:Documentation/laptops/sonypi.rst>, and say Y or M here. + <file:Documentation/admin-guide/laptops/sonypi.rst>, and say Y or M here. To compile this driver as a module, choose M here: the module will be called sonypi.drivers/platform/x86/Kconfig +2
-3@@ -448,7 +448,7 @@ config SONY_LAPTOP screen brightness control, Fn keys and allows powering on/off some devices. - Read <file:Documentation/laptops/sony-laptop.rst> for more information. + Read <file:Documentation/admin-guide/laptops/sony-laptop.rst> 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 - <file:Documentation/laptops/thinkpad-acpi.rst> and + <file:Documentation/admin-guide/laptops/thinkpad-acpi.rst> and <http://ibm-acpi.sf.net/> . This driver was formerly known as ibm-acpi. --2.21.0
Signature · 2 lines
With Best Regards, Andy Shevchenko
Re: [PATCH 04/39] docs: nvdimm: add it to the driver-api book
In reply to Mauro Carvalho ChehabQuoted 4 lines · Mauro Carvalho Chehab
The descriptions here are from Kernel driver's PoV.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
_______________________________________________
Linux-nvdimm mailing list
[email protected]
https://lists.01.org/mailman/listinfo/linux-nvdimm
Re: [PATCH 29/39] docs: driver-api: add a series of orphaned documents
In reply to Mauro Carvalho ChehabQuoted 6 lines · Mauro Carvalho Chehab
There are lots of documents under
Documentation/*.txtand a few other orphan documents elsehwere that belong to the driver-API book.Move them to their right place.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
For the switchtec changes:
Thanks!
Logan
Quoted 728 lines
--- Documentation/ABI/removed/sysfs-class-rfkill | 2 +- Documentation/ABI/stable/sysfs-class-rfkill | 2 +- .../ABI/testing/sysfs-class-switchtec | 2 +- .../admin-guide/kernel-parameters.txt | 2 +- .../admin-guide/laptops/thinkpad-acpi.rst | 6 ++--- .../bt8xxgpio.rst} | 0 .../{connector => driver-api}/connector.rst | 2 +- .../{console => driver-api}/console.rst | 2 +- .../{dcdbas.txt => driver-api/dcdbas.rst} | 0 .../{dell_rbu.txt => driver-api/dell_rbu.rst} | 0 .../{EDID/howto.rst => driver-api/edid.rst} | 2 +- .../{eisa.txt => driver-api/eisa.rst} | 0 Documentation/driver-api/index.rst | 26 +++++++++++++++++++ Documentation/{isa.txt => driver-api/isa.rst} | 0 .../{isapnp.txt => driver-api/isapnp.rst} | 0 .../pblk.txt => driver-api/lightnvm-pblk.rst} | 0 .../men-chameleon-bus.rst} | 0 Documentation/{ntb.txt => driver-api/ntb.rst} | 0 Documentation/{nvmem => driver-api}/nvmem.rst | 2 +- .../parport-lowlevel.rst} | 0 .../{pti => driver-api}/pti_intel_mid.rst | 2 +- Documentation/{pwm.txt => driver-api/pwm.rst} | 0 .../{rfkill.txt => driver-api/rfkill.rst} | 0 .../{sgi-ioc4.txt => driver-api/sgi-ioc4.rst} | 0 .../{SM501.txt => driver-api/sm501.rst} | 0 .../smsc_ece1099.rst} | 0 .../switchtec.rst} | 2 +- .../sync_file.rst} | 0 .../vfio-mediated-device.rst} | 2 +- .../{vfio.txt => driver-api/vfio.rst} | 0 .../{xillybus.txt => driver-api/xillybus.rst} | 0 .../{zorro.txt => driver-api/zorro.rst} | 0 Documentation/fb/fbcon.rst | 4 +-- Documentation/s390/vfio-ccw.rst | 6 ++--- Documentation/w1/w1.netlink | 2 +- MAINTAINERS | 22 ++++++++-------- Next/merge.log | 4 +-- drivers/dma-buf/Kconfig | 2 +- drivers/gpio/Kconfig | 2 +- drivers/gpu/drm/Kconfig | 2 +- drivers/pci/switch/Kconfig | 2 +- drivers/platform/x86/Kconfig | 4 +-- drivers/platform/x86/dcdbas.c | 2 +- drivers/platform/x86/dell_rbu.c | 2 +- drivers/pnp/isapnp/Kconfig | 2 +- drivers/tty/Kconfig | 2 +- drivers/vfio/Kconfig | 2 +- drivers/vfio/mdev/Kconfig | 2 +- drivers/w1/Kconfig | 2 +- samples/Kconfig | 2 +- 50 files changed, 73 insertions(+), 47 deletions(-) rename Documentation/{bt8xxgpio.txt => driver-api/bt8xxgpio.rst} (100%) rename Documentation/{connector => driver-api}/connector.rst (99%) rename Documentation/{console => driver-api}/console.rst (99%) rename Documentation/{dcdbas.txt => driver-api/dcdbas.rst} (100%) rename Documentation/{dell_rbu.txt => driver-api/dell_rbu.rst} (100%) rename Documentation/{EDID/howto.rst => driver-api/edid.rst} (98%) rename Documentation/{eisa.txt => driver-api/eisa.rst} (100%) rename Documentation/{isa.txt => driver-api/isa.rst} (100%) rename Documentation/{isapnp.txt => driver-api/isapnp.rst} (100%) rename Documentation/{lightnvm/pblk.txt => driver-api/lightnvm-pblk.rst} (100%) rename Documentation/{men-chameleon-bus.txt => driver-api/men-chameleon-bus.rst} (100%) rename Documentation/{ntb.txt => driver-api/ntb.rst} (100%) rename Documentation/{nvmem => driver-api}/nvmem.rst (99%) rename Documentation/{parport-lowlevel.txt => driver-api/parport-lowlevel.rst} (100%) rename Documentation/{pti => driver-api}/pti_intel_mid.rst (99%) rename Documentation/{pwm.txt => driver-api/pwm.rst} (100%) rename Documentation/{rfkill.txt => driver-api/rfkill.rst} (100%) rename Documentation/{sgi-ioc4.txt => driver-api/sgi-ioc4.rst} (100%) rename Documentation/{SM501.txt => driver-api/sm501.rst} (100%) rename Documentation/{smsc_ece1099.txt => driver-api/smsc_ece1099.rst} (100%) rename Documentation/{switchtec.txt => driver-api/switchtec.rst} (97%) rename Documentation/{sync_file.txt => driver-api/sync_file.rst} (100%) rename Documentation/{vfio-mediated-device.txt => driver-api/vfio-mediated-device.rst} (99%) rename Documentation/{vfio.txt => driver-api/vfio.rst} (100%) rename Documentation/{xillybus.txt => driver-api/xillybus.rst} (100%) rename Documentation/{zorro.txt => driver-api/zorro.rst} (100%)Documentation/ABI/removed/sysfs-class-rfkill +1
-1@@ -1,6 +1,6 @@ rfkill - radio frequency (RF) connector kill switch support -For details to this subsystem look at Documentation/rfkill.txt. +For details to this subsystem look at Documentation/driver-api/rfkill.rst. What: /sys/class/rfkill/rfkill[0-9]+/claim Date: 09-Jul-2007Documentation/ABI/stable/sysfs-class-rfkill +1
-1@@ -1,6 +1,6 @@ rfkill - radio frequency (RF) connector kill switch support -For details to this subsystem look at Documentation/rfkill.txt. +For details to this subsystem look at Documentation/driver-api/rfkill.rst. For the deprecated /sys/class/rfkill/*/claim knobs of this interface look in Documentation/ABI/removed/sysfs-class-rfkill.Documentation/ABI/testing/sysfs-class-switchtec +1
-1@@ -1,6 +1,6 @@ switchtec - Microsemi Switchtec PCI Switch Management Endpoint -For details on this subsystem look at Documentation/switchtec.txt. +For details on this subsystem look at Documentation/driver-api/switchtec.rst. What: /sys/class/switchtec Date: 05-Jan-2017Documentation/admin-guide/kernel-parameters.txt +1
-1@@ -930,7 +930,7 @@ edid/1680x1050.bin, or edid/1920x1080.bin is given and no file with the same name exists. Details and instructions how to build your own EDID data are - available in Documentation/EDID/howto.rst. An EDID + available in Documentation/driver-api/edid.rst. An EDID data set will only be used for a particular connector, if its name and a colon are prepended to the EDID name. Each connector may use a unique EDID dataDocumentation/admin-guide/laptops/thinkpad-acpi.rst +3
-3@@ -643,7 +643,7 @@ Sysfs notes 2010. rfkill controller switch "tpacpi_bluetooth_sw": refer to - Documentation/rfkill.txt for details. + Documentation/driver-api/rfkill.rst for details. Video output control -- /proc/acpi/ibm/video@@ -1406,7 +1406,7 @@ Sysfs notes 2010. rfkill controller switch "tpacpi_wwan_sw": refer to - Documentation/rfkill.txt for details. + Documentation/driver-api/rfkill.rst for details. EXPERIMENTAL: UWB@@ -1426,7 +1426,7 @@ Sysfs notes ^^^^^^^^^^^ rfkill controller switch "tpacpi_uwb_sw": refer to - Documentation/rfkill.txt for details. + Documentation/driver-api/rfkill.rst for details. Adaptive keyboard -----------------Documentation/driver-api/bt8xxgpio.rst renamed from Documentation/bt8xxgpio.txt +0
-0Documentation/driver-api/connector.rst renamed from Documentation/connector/connector.rst +1
-1@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ================ Kernel ConnectorDocumentation/driver-api/console.rst renamed from Documentation/console/console.rst +1
-1@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 =============== Console DriversDocumentation/driver-api/dcdbas.rst renamed from Documentation/dcdbas.txt +0
-0Documentation/driver-api/dell_rbu.rst renamed from Documentation/dell_rbu.txt +0
-0Documentation/driver-api/edid.rst renamed from Documentation/EDID/howto.rst +1
-1@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ==== EDIDDocumentation/driver-api/eisa.rst renamed from Documentation/eisa.txt +0
-0Documentation/driver-api/index.rst +26
-0@@ -68,7 +68,33 @@ available subsections can be seen below. fpga/index acpi/index backlight/lp855x-driver.rst + bt8xxgpio + connector + console + dcdbas + dell_rbu + edid + eisa + isa + isapnp generic-counter + lightnvm-pblk + men-chameleon-bus + ntb + nvmem + parport-lowlevel + pti_intel_mid + pwm + rfkill + sgi-ioc4 + sm501 + smsc_ece1099 + switchtec + sync_file + vfio-mediated-device + vfio + xillybus + zorro .. only:: subproject and htmlDocumentation/driver-api/isa.rst renamed from Documentation/isa.txt +0
-0Documentation/driver-api/isapnp.rst renamed from Documentation/isapnp.txt +0
-0Documentation/driver-api/lightnvm-pblk.rst renamed from Documentation/lightnvm/pblk.txt +0
-0Documentation/driver-api/men-chameleon-bus.rst renamed from Documentation/men-chameleon-bus.txt +0
-0Documentation/driver-api/ntb.rst renamed from Documentation/ntb.txt +0
-0Documentation/driver-api/nvmem.rst renamed from Documentation/nvmem/nvmem.rst +1
-1@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 =============== NVMEM SubsystemDocumentation/driver-api/parport-lowlevel.rst renamed from Documentation/parport-lowlevel.txt +0
-0Documentation/driver-api/pti_intel_mid.rst renamed from Documentation/pti/pti_intel_mid.rst +1
-1@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ============= Intel MID PTIDocumentation/driver-api/pwm.rst renamed from Documentation/pwm.txt +0
-0Documentation/driver-api/rfkill.rst renamed from Documentation/rfkill.txt +0
-0Documentation/driver-api/sgi-ioc4.rst renamed from Documentation/sgi-ioc4.txt +0
-0Documentation/driver-api/sm501.rst renamed from Documentation/SM501.txt +0
-0Documentation/driver-api/smsc_ece1099.rst renamed from Documentation/smsc_ece1099.txt +0
-0Documentation/driver-api/switchtec.rst renamed from Documentation/switchtec.txt +1
-1@@ -97,6 +97,6 @@ the following configuration settings: NT EP BAR 2 will be dynamically configured as a Direct Window, and the configuration file does not need to configure it explicitly. -Please refer to Documentation/ntb.txt in Linux source tree for an overall +Please refer to Documentation/driver-api/ntb.rst in Linux source tree for an overall understanding of the Linux NTB stack. ntb_hw_switchtec works as an NTB Hardware Driver in this stack.Documentation/driver-api/sync_file.rst renamed from Documentation/sync_file.txt +0
-0Documentation/driver-api/vfio-mediated-device.rst renamed from Documentation/vfio-mediated-device.txt +1
-1@@ -408,7 +408,7 @@ card. References ========== -1. See Documentation/vfio.txt for more information on VFIO. +1. See Documentation/driver-api/vfio.rst for more information on VFIO. 2. struct mdev_driver in include/linux/mdev.h 3. struct mdev_parent_ops in include/linux/mdev.h 4. struct vfio_iommu_driver_ops in include/linux/vfio.hDocumentation/driver-api/vfio.rst renamed from Documentation/vfio.txt +0
-0Documentation/driver-api/xillybus.rst renamed from Documentation/xillybus.txt +0
-0Documentation/driver-api/zorro.rst renamed from Documentation/zorro.txt +0
-0Documentation/fb/fbcon.rst +2
-2@@ -187,7 +187,7 @@ the hardware. Thus, in a VGA console:: Assuming the VGA driver can be unloaded, one must first unbind the VGA driver from the console layer before unloading the driver. The VGA driver cannot be unloaded if it is still bound to the console layer. (See -Documentation/console/console.rst for more information). +Documentation/driver-api/console.rst for more information). This is more complicated in the case of the framebuffer console (fbcon), because fbcon is an intermediate layer between the console and the drivers::@@ -204,7 +204,7 @@ fbcon. Thus, there is no need to explicitly unbind the fbdev drivers from fbcon. So, how do we unbind fbcon from the console? Part of the answer is in -Documentation/console/console.rst. To summarize: +Documentation/driver-api/console.rst. To summarize: Echo a value to the bind file that represents the framebuffer console driver. So assuming vtcon1 represents fbcon, then::Documentation/s390/vfio-ccw.rst +3
-3@@ -38,7 +38,7 @@ every detail. More information/reference could be found here: qemu/hw/s390x/css.c For vfio mediated device framework: -- Documentation/vfio-mediated-device.txt +- Documentation/driver-api/vfio-mediated-device.rst Motivation of vfio-ccw ----------------------@@ -322,5 +322,5 @@ Reference 2. ESA/390 Common I/O Device Commands manual (IBM Form. No. SA22-7204) 3. https://en.wikipedia.org/wiki/Channel_I/O 4. Documentation/s390/cds.rst -5. Documentation/vfio.txt -6. Documentation/vfio-mediated-device.txt +5. Documentation/driver-api/vfio.rst +6. Documentation/driver-api/vfio-mediated-device.rstDocumentation/w1/w1.netlink +1
-1@@ -183,7 +183,7 @@ acknowledge number is set to seq+1. Additional documantion, source code examples. ============================================ -1. Documentation/connector +1. Documentation/driver-api/connector.rst 2. http://www.ioremap.net/archive/w1 This archive includes userspace application w1d.c which uses read/write/search commands for all master/slave devices found on the bus.MAINTAINERS +11
-11@@ -4603,7 +4603,7 @@ DELL SYSTEMS MANAGEMENT BASE DRIVER (dcdbas) M: Stuart Hayes <[email protected]> L: [email protected] S: Maintained -F: Documentation/dcdbas.txt +F: Documentation/driver-api/dcdbas.rst F: drivers/platform/x86/dcdbas.* DELL WMI NOTIFICATIONS DRIVER@@ -8409,7 +8409,7 @@ F: drivers/irqchip/ ISA M: William Breathitt Gray <[email protected]> S: Maintained -F: Documentation/isa.txt +F: Documentation/driver-api/isa.rst F: drivers/base/isa.c F: include/linux/isa.h@@ -8424,7 +8424,7 @@ F: drivers/media/radio/radio-isa* ISAPNP M: Jaroslav Kysela <[email protected]> S: Maintained -F: Documentation/isapnp.txt +F: Documentation/driver-api/isapnp.rst F: drivers/pnp/isapnp/ F: include/linux/isapnp.h@@ -10309,7 +10309,7 @@ M: Johannes Thumshirn <[email protected]> S: Maintained F: drivers/mcb/ F: include/linux/mcb.h -F: Documentation/men-chameleon-bus.txt +F: Documentation/driver-api/men-chameleon-bus.rst MEN F21BMC (Board Management Controller) M: Andreas Werner <[email protected]>@@ -12012,7 +12012,7 @@ F: drivers/parport/ F: include/linux/parport*.h F: drivers/char/ppdev.c F: include/uapi/linux/ppdev.h -F: Documentation/parport*.txt +F: Documentation/driver-api/parport*.rst PARAVIRT_OPS INTERFACE M: Juergen Gross <[email protected]>@@ -12187,7 +12187,7 @@ M: Kurt Schwemmer <[email protected]> M: Logan Gunthorpe <[email protected]> L: [email protected] S: Maintained -F: Documentation/switchtec.txt +F: Documentation/driver-api/switchtec.rst F: Documentation/ABI/testing/sysfs-class-switchtec F: drivers/pci/switch/switchtec* F: include/uapi/linux/switchtec_ioctl.h@@ -12949,7 +12949,7 @@ M: Thierry Reding <[email protected]> L: [email protected] S: Maintained T: git git://git.kernel.org/pub/scm/linux/kernel/git/thierry.reding/linux-pwm.git -F: Documentation/pwm.txt +F: Documentation/driver-api/pwm.rst F: Documentation/devicetree/bindings/pwm/ F: include/linux/pwm.h F: drivers/pwm/@@ -13568,7 +13568,7 @@ W: http://wireless.kernel.org/ T: git git://git.kernel.org/pub/scm/linux/kernel/git/jberg/mac80211.git T: git git://git.kernel.org/pub/scm/linux/kernel/git/jberg/mac80211-next.git S: Maintained -F: Documentation/rfkill.txt +F: Documentation/driver-api/rfkill.rst F: Documentation/ABI/stable/sysfs-class-rfkill F: net/rfkill/ F: include/linux/rfkill.h@@ -15285,7 +15285,7 @@ F: drivers/dma-buf/dma-fence* F: drivers/dma-buf/sw_sync.c F: include/linux/sync_file.h F: include/uapi/linux/sync_file.h -F: Documentation/sync_file.txt +F: Documentation/driver-api/sync_file.rst T: git git://anongit.freedesktop.org/drm/drm-misc SYNOPSYS ARC ARCHITECTURE@@ -16781,7 +16781,7 @@ R: Cornelia Huck <[email protected]> L: [email protected] T: git git://github.com/awilliam/linux-vfio.git S: Maintained -F: Documentation/vfio.txt +F: Documentation/driver-api/vfio.rst F: drivers/vfio/ F: include/linux/vfio.h F: include/uapi/linux/vfio.h@@ -16790,7 +16790,7 @@ VFIO MEDIATED DEVICE DRIVERS M: Kirti Wankhede <[email protected]> L: [email protected] S: Maintained -F: Documentation/vfio-mediated-device.txt +F: Documentation/driver-api/vfio-mediated-device.rst F: drivers/vfio/mdev/ F: include/linux/mdev.h F: samples/vfio-mdev/Next/merge.log +2
-2@@ -13842,7 +13842,7 @@ Merge made by the 'recursive' strategy. .../devicetree/bindings/pwm/pwm-sifive.txt | 33 ++ .../devicetree/bindings/pwm/pwm-stm32-lp.txt | 9 +- .../devicetree/bindings/pwm/pwm-stm32.txt | 3 + - Documentation/pwm.txt | 7 + + Documentation/driver-api/pwm.rst | 7 + drivers/leds/leds-pwm.c | 45 ++- drivers/pwm/Kconfig | 11 + drivers/pwm/Makefile | 1 +@@ -14162,7 +14162,7 @@ Auto-merging drivers/ntb/hw/mscc/ntb_hw_switchtec.c Auto-merging drivers/ntb/Makefile Auto-merging drivers/ntb/Kconfig Merge made by the 'recursive' strategy. - Documentation/ntb.txt | 27 ++ + Documentation/driver-api/ntb.rst | 27 ++ drivers/ntb/Kconfig | 11 + drivers/ntb/Makefile | 3 + drivers/ntb/{ntb.c => core.c} | 0drivers/dma-buf/Kconfig +1
-1@@ -15,7 +15,7 @@ config SYNC_FILE associated with a buffer. When a job is submitted to the GPU a fence is attached to the buffer and is transferred via userspace, using Sync Files fds, to the DRM driver for example. More details at - Documentation/sync_file.txt. + Documentation/driver-api/sync_file.rst. config SW_SYNC bool "Sync File Validation Framework"drivers/gpio/Kconfig +1
-1@@ -1300,7 +1300,7 @@ config GPIO_BT8XX The card needs to be physically altered for using it as a GPIO card. For more information on how to build a GPIO card from a BT8xx TV card, see the documentation file at - Documentation/bt8xxgpio.txt + Documentation/driver-api/bt8xxgpio.rst If unsure, say N.drivers/gpu/drm/Kconfig +1
-1@@ -141,7 +141,7 @@ config DRM_LOAD_EDID_FIRMWARE monitor are unable to provide appropriate EDID data. Since this feature is provided as a workaround for broken hardware, the default case is N. Details and instructions how to build your own - EDID data are given in Documentation/EDID/howto.rst. + EDID data are given in Documentation/driver-api/edid.rst. config DRM_DP_CEC bool "Enable DisplayPort CEC-Tunneling-over-AUX HDMI support"drivers/pci/switch/Kconfig +1
-1@@ -9,7 +9,7 @@ config PCI_SW_SWITCHTEC Enables support for the management interface for the MicroSemi Switchtec series of PCIe switches. Supports userspace access to submit MRPC commands to the switch via /dev/switchtecX - devices. See <file:Documentation/switchtec.txt> for more + devices. See <file:Documentation/driver-api/switchtec.rst> for more information. endmenudrivers/platform/x86/Kconfig +2
-2@@ -118,7 +118,7 @@ config DCDBAS Interrupts (SMIs) and Host Control Actions (system power cycle or power off after OS shutdown) on certain Dell systems. - See <file:Documentation/dcdbas.txt> for more details on the driver + See <file:Documentation/driver-api/dcdbas.rst> for more details on the driver and the Dell systems on which Dell systems management software makes use of this driver.@@ -259,7 +259,7 @@ config DELL_RBU DELL system. Note you need a Dell OpenManage or Dell Update package (DUP) supporting application to communicate with the BIOS regarding the new image for the image update to take effect. - See <file:Documentation/dell_rbu.txt> for more details on the driver. + See <file:Documentation/driver-api/dell_rbu.rst> for more details on the driver. config FUJITSU_LAPTOPdrivers/platform/x86/dcdbas.c +1
-1@@ -7,7 +7,7 @@* and Host Control Actions (power cycle or power off after OS shutdown) on * Dell systems. * -* See Documentation/dcdbas.txt for more information. +* See Documentation/driver-api/dcdbas.rst for more information. * * Copyright (C) 1995-2006 Dell Inc. */ drivers/platform/x86/dell_rbu.c +1
-1@@ -24,7 +24,7 @@* on every time the packet data is written. This driver requires an * application to break the BIOS image in to fixed sized packet chunks. * -* See Documentation/dell_rbu.txt for more info. +* See Documentation/driver-api/dell_rbu.rst for more info. */ #include <linux/init.h> #include <linux/module.h> drivers/pnp/isapnp/Kconfig +1
-1@@ -7,6 +7,6 @@ config ISAPNP depends on ISA || COMPILE_TEST help Say Y here if you would like support for ISA Plug and Play devices. - Some information is in <file:Documentation/isapnp.txt>. + Some information is in <file:Documentation/driver-api/isapnp.rst>. If unsure, say Y.drivers/tty/Kconfig +1
-1@@ -93,7 +93,7 @@ config VT_HW_CONSOLE_BINDING select the console driver that will serve as the backend for the virtual terminals. - See <file:Documentation/console/console.rst> for more + See <file:Documentation/driver-api/console.rst> for more information. For framebuffer console users, please refer to <file:Documentation/fb/fbcon.rst>.drivers/vfio/Kconfig +1
-1@@ -25,7 +25,7 @@ menuconfig VFIO select VFIO_IOMMU_TYPE1 if (X86 || S390 || ARM || ARM64) help VFIO provides a framework for secure userspace device drivers. - See Documentation/vfio.txt for more details. + See Documentation/driver-api/vfio.rst for more details. If you don't know what to do here, say N.drivers/vfio/mdev/Kconfig +1
-1@@ -6,7 +6,7 @@ config VFIO_MDEV default n help Provides a framework to virtualize devices. - See Documentation/vfio-mediated-device.txt for more details. + See Documentation/driver-api/vfio-mediated-device.rst for more details. If you don't know what do here, say N.drivers/w1/Kconfig +1
-1@@ -19,7 +19,7 @@ config W1_CON default y ---help--- This allows to communicate with userspace using connector. For more - information see <file:Documentation/connector/connector.rst>. + information see <file:Documentation/driver-api/connector.rst>. There are three types of messages between w1 core and userspace: 1. Events. They are generated each time new master or slave device found either due to automatic or requested search.samples/Kconfig +1
-1@@ -99,7 +99,7 @@ config SAMPLE_CONNECTOR When enabled, this builds both a sample kernel module for the connector interface and a user space tool to communicate with it. - See also Documentation/connector/connector.rst + See also Documentation/driver-api/connector.rst config SAMPLE_HIDRAW bool "hidraw sample"
Re: [PATCH 24/39] docs: driver-model: move it to the driver-api book
In reply to Mauro Carvalho ChehabQuoted 3 lines · Mauro Carvalho Chehab
The audience for the Kernel driver-model is clearly Kernel hackers.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
For the 'ice' driver changes.
Quoted 30 lines
---
Documentation/{ => driver-api}/driver-model/binding.rst | 0
Documentation/{ => driver-api}/driver-model/bus.rst | 0
Documentation/{ => driver-api}/driver-model/class.rst | 0
.../{ => driver-api}/driver-model/design-patterns.rst | 0
Documentation/{ => driver-api}/driver-model/device.rst | 0
Documentation/{ => driver-api}/driver-model/devres.rst | 0
Documentation/{ => driver-api}/driver-model/driver.rst | 0
Documentation/{ => driver-api}/driver-model/index.rst | 2 --
Documentation/{ => driver-api}/driver-model/overview.rst | 0
Documentation/{ => driver-api}/driver-model/platform.rst | 0
Documentation/{ => driver-api}/driver-model/porting.rst | 2 +-
Documentation/driver-api/gpio/driver.rst | 2 +-
Documentation/driver-api/index.rst | 1 +
Documentation/eisa.txt | 4 ++--
Documentation/filesystems/sysfs.txt | 2 +-
Documentation/hwmon/submitting-patches.rst | 2 +-
Documentation/translations/zh_CN/filesystems/sysfs.txt | 2 +-
drivers/base/platform.c | 2 +-
drivers/gpio/gpio-cs5535.c | 2 +-
drivers/net/ethernet/intel/ice/ice_main.c | 2 +-
drivers/staging/unisys/Documentation/overview.txt | 4 ++--
include/linux/device.h | 2 +-
include/linux/platform_device.h | 2 +-
scripts/coccinelle/free/devm_free.cocci | 2 +-
24 files changed, 16 insertions(+), 17 deletions(-)
rename Documentation/{ => driver-api}/driver-model/binding.rst (100%)
rename Documentation/{ => driver-api}/driver-model/bus.rst (100%)
rename Documentation/{ => driver-api}/driver-model/class.rst (100%)
rename Documentation/{ => driver-api}/driver-model/design-patterns.rstQuoted 8 lines
(100%)
rename Documentation/{ => driver-api}/driver-model/device.rst (100%) rename Documentation/{ => driver-api}/driver-model/devres.rst (100%) rename Documentation/{ => driver-api}/driver-model/driver.rst (100%) rename Documentation/{ => driver-api}/driver-model/index.rst (96%) rename Documentation/{ => driver-api}/driver-model/overview.rst (100%) rename Documentation/{ => driver-api}/driver-model/platform.rst (100%) rename Documentation/{ => driver-api}/driver-model/porting.rst (99%)
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: This is a digitally signed message part
URL: <http://lists.osuosl.org/pipermail/intel-wired-lan/attachments/20190628/d95c49aa/attachment.asc>
Re: [PATCH 22/39] docs: ocxl.rst: add it to the uAPI book
In reply to Mauro Carvalho ChehabQuoted 3 lines · Mauro Carvalho Chehab
The content of this file is user-faced.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
Quoted 46 lines
--- Documentation/{ => userspace-api}/accelerators/ocxl.rst | 2 -- Documentation/userspace-api/index.rst | 1 + MAINTAINERS | 2 +- 3 files changed, 2 insertions(+), 3 deletions(-)rename
Documentation/{=>userspace-api}/accelerators/ocxl.rst(99%)Documentation/userspace-api/accelerators/ocxl.rst renamed from Documentation/accelerators/ocxl.rst +0
-2@@ -1,5 +1,3 @@ -:orphan: - ======================================================== OpenCAPI (Open Coherent Accelerator Processor Interface) ========================================================Documentation/userspace-api/index.rst +1
-0@@ -20,6 +20,7 @@ place where this information is gathered. seccomp_filter unshare spec_ctrl + accelerators/ocxl .. only:: subproject and htmlMAINTAINERS +1
-1@@ -11483,7 +11483,7 @@ F: arch/powerpc/include/asm/pnv-ocxl.h F: drivers/misc/ocxl/ F: include/misc/ocxl* F: include/uapi/misc/ocxl.h -F: Documentation/accelerators/ocxl.rst +F: Documentation/userspace-api/accelerators/ocxl.rst OMAP AUDIO SUPPORT M: Peter Ujfalusi <[email protected]>
Signature · 2 lines
Andrew Donnellan OzLabs, ADL Canberra [email protected] IBM Australia Limited
Re: [PATCH 29/39] docs: driver-api: add a series of orphaned documents
In reply to Mauro Carvalho ChehabQuoted 7 lines · On Fri, 28 Jun 2019 09:30:22 -0300 Mauro Carvalho Chehab…
There are lots of documents under
Documentation/*.txtand a few other orphan documents elsehwere that belong to the driver-API book.Move them to their right place.
Signed-off-by Mauro Carvalho Chehab <[email protected]>---
(...)
Quoted 2 lines
.../vfio-mediated-device.rst} | 2 +-
.../{vfio.txt => driver-api/vfio.rst} | 0(...)
Quoted 1 line
Documentation/s390/vfio-ccw.rst | 6 ++---
(...)
Quoted 2 lines
drivers/vfio/Kconfig | 2 +- drivers/vfio/mdev/Kconfig | 2 +-
_______________________________________________
dri-devel mailing list
[email protected]
https://lists.freedesktop.org/mailman/listinfo/dri-devel
Re: [PATCH 39/39] docs: gpio: add sysfs interface to the admin-guide
In reply to Mauro Carvalho ChehabQuoted 4 lines · Mauro Carvalho Chehab
While this is stated as obsoleted, the sysfs interface described there is still valid, and belongs to the admin-guide.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
This doesn't apply to my tree because of dependencies in the index so I guess it's best if you merge it:
Yours,
Linus Walleij
Re: [PATCH 35/39] docs: infiniband: add it to the driver-api bookset
In reply to Mauro Carvalho ChehabQuoted 24 lines · Mauro Carvalho Chehab
While this contains some uAPI stuff, it was intended to be read by a kernel doc. So, let's not move it to a different dir, but, instead, just add it to the driver-api bookset.
Signed-off-by Mauro Carvalho Chehab <[email protected]>Documentation/index.rst | 1 + Documentation/infiniband/index.rst | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-)Documentation/index.rst +2
-0+++ b/Documentation/index.rst@@ -96,6 +96,7 @@ needed). block/index hid/index iio/index + infiniband/index leds/index media/index networking/indexDocumentation/infiniband/index.rst +1
-0+++ b/Documentation/infiniband/index.rst
Documentation/infiniband/index.rst line 4
Quoted 5 lines
Documentation/infiniband/index.rst +1
-1@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0 ========== InfiniBand
Should this one go to the rdma.git as well? It looks like yes
Thanks,
Jason
Re: [PATCH 18/39] docs: admin-guide: add kdump documentation into it
In reply to Mauro Carvalho ChehabQuoted 11 lines · Mauro Carvalho Chehab
The Kdump documentation describes procedures with admins use in order to solve issues on their systems.
Signed-off-by Mauro Carvalho Chehab <[email protected]>--- Documentation/admin-guide/bug-hunting.rst | 4 ++-- Documentation/admin-guide/index.rst | 1 + Documentation/{ => admin-guide}/kdump/gdbmacros.txt | 0 Documentation/{ => admin-guide}/kdump/index.rst | 1 - Documentation/{ => admin-guide}/kdump/kdump.rst | 0 Documentation/{ => admin-guide}/kdump/vmcoreinfo.rst | 0
I am not sure if it's convenience for people to have more levels in docs.
But I guess, move archs into a Documentation/arch/ dir should be fine. like Documentation/arch/{x86,arm,arm64,ia64,m68k,s390,powerpc,...}
Thanks
Alex
_______________________________________________
kexec mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/kexec
Re: [PATCH 18/39] docs: admin-guide: add kdump documentation into it
In reply to Mauro Carvalho ChehabQuoted 226 lines · Mauro Carvalho Chehab
The Kdump documentation describes procedures with admins use in order to solve issues on their systems.
Signed-off-by Mauro Carvalho Chehab <[email protected]>--- Documentation/admin-guide/bug-hunting.rst | 4 ++-- Documentation/admin-guide/index.rst | 1 + Documentation/{ => admin-guide}/kdump/gdbmacros.txt | 0 Documentation/{ => admin-guide}/kdump/index.rst | 1 - Documentation/{ => admin-guide}/kdump/kdump.rst | 0 Documentation/{ => admin-guide}/kdump/vmcoreinfo.rst | 0 Documentation/admin-guide/kernel-parameters.txt | 6 +++--- Documentation/powerpc/firmware-assisted-dump.rst | 2 +- Documentation/translations/zh_CN/oops-tracing.txt | 4 ++-- Documentation/watchdog/hpwdt.rst | 2 +- MAINTAINERS | 2 +- arch/arm/Kconfig | 2 +- arch/arm64/Kconfig | 2 +- arch/sh/Kconfig | 2 +- arch/x86/Kconfig | 4 ++-- 15 files changed, 16 insertions(+), 16 deletions(-) rename Documentation/{ => admin-guide}/kdump/gdbmacros.txt (100%) rename Documentation/{ => admin-guide}/kdump/index.rst (97%) rename Documentation/{ => admin-guide}/kdump/kdump.rst (100%) rename Documentation/{ => admin-guide}/kdump/vmcoreinfo.rst (100%)Documentation/admin-guide/bug-hunting.rst +2
-2@@ -90,9 +90,9 @@ the disk is not available then you have three options: run a null modem to a second machine and capture the output there using your favourite communication program. Minicom works well. -(3) Use Kdump (see Documentation/kdump/kdump.rst), +(3) Use Kdump (see Documentation/admin-guide/kdump/kdump.rst), extract the kernel ring buffer from old memory with using dmesg - gdbmacro in Documentation/kdump/gdbmacros.txt. + gdbmacro in Documentation/admin-guide/kdump/gdbmacros.txt. Finding the bug's location --------------------------Documentation/admin-guide/index.rst +1
-0@@ -39,6 +39,7 @@ problems and bugs in particular. ramoops dynamic-debug-howto init + kdump/index perf/index This is the beginning of a section with information of interest toDocumentation/admin-guide/kdump/gdbmacros.txt renamed from Documentation/kdump/gdbmacros.txt +0
-0Documentation/admin-guide/kdump/index.rst renamed from Documentation/kdump/index.rst +0
-1@@ -1,4 +1,3 @@ -:orphan: ================================================================ Documentation for Kdump - The kexec-based Crash Dumping SolutionDocumentation/admin-guide/kdump/kdump.rst renamed from Documentation/kdump/kdump.rst +0
-0Documentation/admin-guide/kdump/vmcoreinfo.rst renamed from Documentation/kdump/vmcoreinfo.rst +0
-0Documentation/admin-guide/kernel-parameters.txt +3
-3@@ -708,14 +708,14 @@ [KNL, x86_64] select a region under 4G first, and fall back to reserve region above 4G when '@offset' hasn't been specified. - See Documentation/kdump/kdump.rst for further details. + See Documentation/admin-guide/kdump/kdump.rst for further details. crashkernel=range1:size1[,range2:size2,...][@offset] [KNL] Same as above, but depends on the memory in the running system. The syntax of range is start-[end] where start and end are both a memory unit (amount[KMG]). See also - Documentation/kdump/kdump.rst for an example. + Documentation/admin-guide/kdump/kdump.rst for an example. crashkernel=size[KMG],high [KNL, x86_64] range could be above 4G. Allow kernel@@ -1207,7 +1207,7 @@ Specifies physical address of start of kernel core image elf header and optionally the size. Generally kexec loader will pass this option to capture kernel. - See Documentation/kdump/kdump.rst for details. + See Documentation/admin-guide/kdump/kdump.rst for details. enable_mtrr_cleanup [X86] The kernel tries to adjust MTRR layout from continuousDocumentation/powerpc/firmware-assisted-dump.rst +1
-1@@ -61,7 +61,7 @@ as follows: the default calculated size. Use this option if default boot memory size is not sufficient for second kernel to boot successfully. For syntax of crashkernel= parameter, - refer to Documentation/kdump/kdump.rst. If any offset is + refer to Documentation/admin-guide/kdump/kdump.rst. If any offset is provided in crashkernel= parameter, it will be ignored as fadump uses a predefined offset to reserve memory for boot memory dump preservation in case of a crash.Documentation/translations/zh_CN/oops-tracing.txt +2
-2@@ -53,8 +53,8 @@ cat /proc/kmsg > file, 然而你必须介入中止传输, kmsg是一个“ (2)用串口终端启动(请参看Documentation/admin-guide/serial-console.rst),运行一个null modem到另一台机器并用你喜欢的通讯工具获取输出。Minicom工作地很好。 -(3)使用Kdump(请参看Documentation/kdump/kdump.rst), -使用在Documentation/kdump/gdbmacros.txt中定义的dmesg gdb宏,从旧的内存中提取内核 +(3)使用Kdump(请参看Documentation/admin-guide/kdump/kdump.rst), +使用在Documentation/admin-guide/kdump/gdbmacros.txt中定义的dmesg gdb宏,从旧的内存中提取内核 环形缓冲区。 完整信息Documentation/watchdog/hpwdt.rst +1
-1@@ -59,7 +59,7 @@ Last reviewed: 08/20/2018 and loop forever. This is generally not what a watchdog user wants. For those wishing to learn more please see: - Documentation/kdump/kdump.rst + Documentation/admin-guide/kdump/kdump.rst Documentation/admin-guide/kernel-parameters.txt (panic=) Your Linux Distribution specific documentation.MAINTAINERS +1
-1@@ -8622,7 +8622,7 @@ R: Vivek Goyal <[email protected]> L: [email protected] W: http://lse.sourceforge.net/kdump/ S: Maintained -F: Documentation/kdump/ +F: Documentation/admin-guide/kdump/ KEENE FM RADIO TRANSMITTER DRIVER M: Hans Verkuil <[email protected]>arch/arm/Kconfig +1
-1@@ -2025,7 +2025,7 @@ config CRASH_DUMP kdump/kexec. The crash dump kernel must be compiled to a memory address not used by the main kernel - For more details see Documentation/kdump/kdump.rst + For more details see Documentation/admin-guide/kdump/kdump.rst config AUTO_ZRELADDR bool "Auto calculation of the decompressed kernel image address"arch/arm64/Kconfig +1
-1@@ -997,7 +997,7 @@ config CRASH_DUMP reserved region and then later executed after a crash by kdump/kexec. - For more details see Documentation/kdump/kdump.rst + For more details see Documentation/admin-guide/kdump/kdump.rst config XEN_DOM0 def_bool yarch/sh/Kconfig +1
-1@@ -626,7 +626,7 @@ config CRASH_DUMP to a memory address not used by the main kernel using PHYSICAL_START. - For more details see Documentation/kdump/kdump.rst + For more details see Documentation/admin-guide/kdump/kdump.rst config KEXEC_JUMP bool "kexec jump (EXPERIMENTAL)"arch/x86/Kconfig +2
-2@@ -2057,7 +2057,7 @@ config CRASH_DUMP to a memory address not used by the main kernel or BIOS using PHYSICAL_START, or it must be built as a relocatable image (CONFIG_RELOCATABLE=y). - For more details see Documentation/kdump/kdump.rst + For more details see Documentation/admin-guide/kdump/kdump.rst config KEXEC_JUMP bool "kexec jump"@@ -2094,7 +2094,7 @@ config PHYSICAL_START the reserved region. In other words, it can be set based on the "X" value as specified in the "crashkernel=YM@XM" command line boot parameter passed to the panic-ed - kernel. Please take a look at Documentation/kdump/kdump.rst + kernel. Please take a look at Documentation/admin-guide/kdump/kdump.rst for more details about crash dumps. Usage of bzImage for capturing the crash dump is recommended asSignature · 1 line
2.21.0
Thanks
Dave
_______________________________________________
kexec mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/kexec
Re: [PATCH 18/39] docs: admin-guide: add kdump documentation into it
In reply to Alex ShiQuoted 15 lines · Alex Shi
Quoted 11 lines · Mauro Carvalho Chehab
The Kdump documentation describes procedures with admins use in order to solve issues on their systems.
Signed-off-by Mauro Carvalho Chehab <[email protected]>--- Documentation/admin-guide/bug-hunting.rst | 4 ++-- Documentation/admin-guide/index.rst | 1 + Documentation/{ => admin-guide}/kdump/gdbmacros.txt | 0 Documentation/{ => admin-guide}/kdump/index.rst | 1 - Documentation/{ => admin-guide}/kdump/kdump.rst | 0 Documentation/{ => admin-guide}/kdump/vmcoreinfo.rst | 0
Quoted 3 lines
I am not sure if it's convenience for people to have more levels in docs.
But I guess, move archs into a
Documentation/arch/dir should be fine. likeDocumentation/arch/{x86,arm,arm64,ia64,m68k,s390,powerpc,...}
Alex, moving kdump to admin-guide sounds reasonable to me. I also agree with you for those arch dependent files can be moved to Documentation/arch/, maybe you are talking about some other patches in the series for the arch/?
Thanks
dave
_______________________________________________
kexec mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/kexec
Re: [PATCH 35/39] docs: infiniband: add it to the driver-api bookset
In reply to Jason GunthorpeEm Wed, 3 Jul 2019 15:08:02 -0300
Jason Gunthorpe <[email protected]> escreveu:
Quoted 28 lines · Mauro Carvalho Chehab
Quoted 27 lines
While this contains some uAPI stuff, it was intended to be read by a kernel doc. So, let's not move it to a different dir, but, instead, just add it to the driver-api bookset.
Signed-off-by Mauro Carvalho Chehab <[email protected]>Documentation/index.rst | 1 + Documentation/infiniband/index.rst | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-)Documentation/index.rst +2
-0+++ b/Documentation/index.rst@@ -96,6 +96,7 @@ needed). block/index hid/index iio/index + infiniband/index leds/index media/index networking/indexDocumentation/infiniband/index.rst +2
-1+++ b/Documentation/infiniband/index.rst@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0
Quoted 4 lines
Documentation/infiniband/index.rst line 4
Quoted 2 lines
Documentation/infiniband/index.rst +0
-0========== InfiniBandShould this one go to the rdma.git as well? It looks like yes
I'm OK if you want to add to rdma.git. However, this will likely rise conflicts, though, as this series has lots of other patches touching Documentation/index.rst.
So, I suspect that it would be easier to merge this together with the other patches via the docs tree, by the end of the merge window.
If you prefer to apply it against your tree, my plan is to do a final rebase at the second week of the merge window, in order to avoid such conflicts.
Thanks,
Mauro
Re: [PATCH 39/39] docs: gpio: add sysfs interface to the admin-guide
In reply to Linus WalleijEm Wed, 3 Jul 2019 10:44:38 +0200
Linus Walleij <[email protected]> escreveu:
Quoted 10 lines
Quoted 4 lines · Mauro Carvalho Chehab
While this is stated as obsoleted, the sysfs interface described there is still valid, and belongs to the admin-guide.
Signed-off-by Mauro Carvalho Chehab <[email protected]>This doesn't apply to my tree because of dependencies in the index
Yeah, this /39 patch series heavily touch the index files. Better to merge them altogether.
Quoted 2 lines
so I guess it's best if you merge it:
Acked-by Linus Walleij <[email protected]>
Thanks!
Mauro
Quoted 3 lines
Yours,
Linus Walleij
Thanks,
Mauro
Re: [PATCH 18/39] docs: admin-guide: add kdump documentation into it
In reply to Dave YoungEm Fri, 5 Jul 2019 13:59:04 +0800
Dave Young <[email protected]> escreveu:
Quoted 16 lines · Alex Shi
Quoted 15 lines · Mauro Carvalho Chehab
Quoted 11 lines
The Kdump documentation describes procedures with admins use in order to solve issues on their systems.
Signed-off-by Mauro Carvalho Chehab <[email protected]>--- Documentation/admin-guide/bug-hunting.rst | 4 ++-- Documentation/admin-guide/index.rst | 1 + Documentation/{ => admin-guide}/kdump/gdbmacros.txt | 0 Documentation/{ => admin-guide}/kdump/index.rst | 1 - Documentation/{ => admin-guide}/kdump/kdump.rst | 0 Documentation/{ => admin-guide}/kdump/vmcoreinfo.rst | 0
Quoted 8 lines
Quoted 3 lines
I am not sure if it's convenience for people to have more levels in docs.
But I guess, move archs into a
Documentation/arch/dir should be fine. likeDocumentation/arch/{x86,arm,arm64,ia64,m68k,s390,powerpc,...}Alex, moving kdump to admin-guide sounds reasonable to me. I also agree with you for those arch dependent files can be moved to
Documentation/arch/, maybe you are talking about some other patches in the series for thearch/?
Alex,
It makes sense for me to have a Documentation/arch directory, and place the arch-specific docs over there.
There's actually a technical advantage on doing that: Sphinx is dumb with regards to PDF/LaTeX output: it requires all top documents to be listed at Documentation/conf.py, under this var:
latex_documents = [ ... ]
As it creates one runtime Makefile at Documentation/output per listed document there. So, the more we group such documents, the less merge conflicts we'll have at Documentation/conf.py.
Btw, there's a [TECH TOPIC] proposal for KS/2019 meant to discuss Documentation.
I suspect we could discuss the pros/cons of doing such change there.
My personal view is that we should keep the Documentation/ root dir as clean as possible as a long term goal.
On the other hand, it makes the path bigger and harder to rename.
On a side note, last time we discussed documentation at KS I remember I proposed to shortcut "Documentation/" to just "docs/". The consensus on that time were to keep the big name. I still think that a shorter one could help people to remind where documentation will be located.
Thanks,
Mauro
_______________________________________________
kexec mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/kexec
Re: [PATCH 35/39] docs: infiniband: add it to the driver-api bookset
In reply to Mauro Carvalho ChehabQuoted 31 lines · Mauro Carvalho Chehab
Em Wed, 3 Jul 2019 15:08:02 -0300
Jason Gunthorpe <[email protected]> escreveu:Quoted 28 lines · Mauro Carvalho Chehab
Quoted 27 lines
While this contains some uAPI stuff, it was intended to be read by a kernel doc. So, let's not move it to a different dir, but, instead, just add it to the driver-api bookset.
Signed-off-by Mauro Carvalho Chehab <[email protected]>Documentation/index.rst | 1 + Documentation/infiniband/index.rst | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-)Documentation/index.rst +2
-0+++ b/Documentation/index.rst@@ -96,6 +96,7 @@ needed). block/index hid/index iio/index + infiniband/index leds/index media/index networking/indexDocumentation/infiniband/index.rst +2
-1+++ b/Documentation/infiniband/index.rst@@ -1,4 +1,4 @@ -:orphan: +.. SPDX-License-Identifier: GPL-2.0
Quoted 8 lines
Quoted 4 lines
Documentation/infiniband/index.rst line 4
Quoted 2 lines
Documentation/infiniband/index.rst +0
-0========== InfiniBandShould this one go to the rdma.git as well? It looks like yes
I'm OK if you want to add to rdma.git. However, this will likely rise conflicts, though, as this series has lots of other patches touching
Documentation/index.rst.
Applied now, it seems better to keep everything consistent
Jason