Convert files to ReST - part 3
Subsystems (108)
PATCH 11/22 docs: admin-guide: add .rst files from the main dir
In reply to Mauro Carvalho ChehabThose files belong to the admin guide. Add them to the admin-guide book.
---
I had to remove the long list of maintainers got by getpatch.pl, as it was too long. I opted to keep only the mailing lists.
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 ++--
Documentation/{ => admin-guide}/aoe/aoe.rst | 4 ++--
.../{ => admin-guide}/aoe/autoload.sh | 1 -
.../{ => 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 | 4 ++--
Documentation/{ => admin-guide}/aoe/udev.txt | 8 +++----
Documentation/{ => admin-guide}/btmrvl.rst | 2 --
.../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 +-
.../{ => admin-guide}/clearing-warn-once.rst | 2 --
Documentation/{ => admin-guide}/cpu-load.rst | 2 --
.../{ => admin-guide}/cputopology.rst | 2 --
Documentation/{ => admin-guide}/efi-stub.rst | 2 --
Documentation/{ => admin-guide}/highuid.rst | 2 --
Documentation/admin-guide/hw-vuln/l1tf.rst | 2 +-
Documentation/{ => admin-guide}/hw_random.rst | 2 --
Documentation/admin-guide/index.rst | 23 +++++++++++++++++++
Documentation/{ => admin-guide}/iostats.rst | 2 --
.../admin-guide/kernel-parameters.txt | 6 ++---
.../kernel-per-cpu-kthreads.rst} | 4 +---
.../lcd-panel-cgram.rst | 2 --
Documentation/{ => admin-guide}/ldm.rst | 2 --
.../{ => admin-guide}/lockup-watchdogs.rst | 2 --
.../mm/cma_debugfs.rst} | 2 --
.../admin-guide/mm/numa_memory_policy.rst | 2 +-
Documentation/{ => admin-guide}/numastat.rst | 4 +---
Documentation/{ => admin-guide}/pnp.rst | 2 --
Documentation/{ => admin-guide}/rtc.rst | 2 --
Documentation/{ => admin-guide}/svga.rst | 2 --
.../{ => admin-guide}/video-output.rst | 2 --
Documentation/block/bfq-iosched.rst | 2 +-
Documentation/device-mapper/statistics.rst | 4 ++--
Documentation/driver-api/index.rst | 2 +-
Documentation/fb/vesafb.rst | 2 +-
Documentation/filesystems/tmpfs.txt | 2 +-
Documentation/scheduler/sched-deadline.rst | 2 +-
Documentation/scheduler/sched-design-CFS.rst | 2 +-
Documentation/scheduler/sched-rt-group.rst | 2 +-
Documentation/sysctl/kernel.rst | 2 +-
Documentation/vm/numa.rst | 4 ++--
Documentation/vm/page_migration.rst | 2 +-
Documentation/vm/unevictable-lru.rst | 2 +-
Documentation/x86/topology.rst | 2 +-
.../x86/x86_64/fake-numa-for-cpusets.rst | 4 ++--
MAINTAINERS | 18 +++++++--------
arch/arm/Kconfig | 2 +-
arch/parisc/Kconfig | 2 +-
arch/sh/Kconfig | 2 +-
arch/sparc/Kconfig | 2 +-
arch/x86/Kconfig | 4 ++--
block/Kconfig | 2 +-
block/partitions/Kconfig | 2 +-
drivers/char/Kconfig | 4 ++--
drivers/char/hw_random/core.c | 2 +-
include/linux/cgroup-defs.h | 2 +-
include/linux/hw_random.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 +-
80 files changed, 94 insertions(+), 112 deletions(-)
rename Documentation/{ => admin-guide}/aoe/aoe.rst (97%)
rename Documentation/{ => admin-guide}/aoe/autoload.sh (99%)
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 (92%)
rename Documentation/{ => admin-guide}/aoe/udev.txt (91%)
rename Documentation/{ => admin-guide}/btmrvl.rst (99%)
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/{ => admin-guide}/clearing-warn-once.rst (96%)
rename Documentation/{ => admin-guide}/cpu-load.rst (99%)
rename Documentation/{ => admin-guide}/cputopology.rst (99%)
rename Documentation/{ => admin-guide}/efi-stub.rst (99%)
rename Documentation/{ => admin-guide}/highuid.rst (99%)
rename Documentation/{ => admin-guide}/hw_random.rst (99%)
rename Documentation/{ => admin-guide}/iostats.rst (99%)
rename Documentation/{kernel-per-CPU-kthreads.rst => admin-guide/kernel-per-cpu-kthreads.rst} (99%)
rename Documentation/{auxdisplay => admin-guide}/lcd-panel-cgram.rst (99%)
rename Documentation/{ => admin-guide}/ldm.rst (99%)
rename Documentation/{ => admin-guide}/lockup-watchdogs.rst (99%)
rename Documentation/{cma/debugfs.rst => admin-guide/mm/cma_debugfs.rst} (98%)
rename Documentation/{ => admin-guide}/numastat.rst (93%)
rename Documentation/{ => admin-guide}/pnp.rst (99%)
rename Documentation/{ => admin-guide}/rtc.rst (99%)
rename Documentation/{ => admin-guide}/svga.rst (99%)
rename Documentation/{ => admin-guide}/video-output.rst (99%)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.rst + 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.rst + 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.rst + 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.rst 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.rst for more information. + See Documentation/admin-guide/cputopology.rst for more information. What: /sys/devices/system/cpu/cpuidle/current_driver
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 -1
@@ -14,4 +14,3 @@ if [ $? = 1 ]; then echo alias block-major-152 aoe >> $f echo alias char-major-152 aoe >> $f fi -
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 +2 -2
@@ -1,6 +1,6 @@ -# install the aoe-specific udev rules from udev.txt into +# install the aoe-specific udev rules from udev.txt into # the system's udev configuration -# +# me="`basename $0`"
Documentation/admin-guide/aoe/udev.txt renamed from Documentation/aoe/udev.txt +4 -4
@@ -2,7 +2,7 @@ # They may be installed along the following lines. Check the section # 8 udev manpage to see whether your udev supports SUBSYSTEM, and # whether it uses one or two equal signs for SUBSYSTEM and KERNEL. -# +# # ecashin@makki ~$ su # Password: # bash# find /etc -type f -name udev.conf
@@ -11,9 +11,9 @@ # 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 -# +# # aoe char devices SUBSYSTEM=="aoe", KERNEL=="discover", NAME="etherd/%k", GROUP="disk", MODE="0220"
@@ -22,5 +22,5 @@ SUBSYSTEM=="aoe", KERNEL=="interfaces", NAME="etherd/%k", GROUP="disk", MODE="02 SUBSYSTEM=="aoe", KERNEL=="revalidate", NAME="etherd/%k", GROUP="disk", MODE="0220" SUBSYSTEM=="aoe", KERNEL=="flush", NAME="etherd/%k", GROUP="disk", MODE="0220" -# aoe block devices +# aoe block devices KERNEL=="etherd*", GROUP="disk"
Documentation/admin-guide/btmrvl.rst renamed from Documentation/btmrvl.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============= btmrvl driver =============
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/clearing-warn-once.rst renamed from Documentation/clearing-warn-once.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - Clearing WARN_ONCE ------------------
Documentation/admin-guide/cpu-load.rst renamed from Documentation/cpu-load.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ======== CPU load ========
Documentation/admin-guide/cputopology.rst renamed from Documentation/cputopology.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =========================================== How CPU topology info is exported via sysfs ===========================================
Documentation/admin-guide/efi-stub.rst renamed from Documentation/efi-stub.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================= The EFI Boot Stub =================
Documentation/admin-guide/highuid.rst renamed from Documentation/highuid.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =================================================== Notes on the change from 16-bit UIDs to 32-bit UIDs ===================================================
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.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ========================================================== Linux support for random number generator in i8xx chipsets ==========================================================
Documentation/admin-guide/index.rst +23 -0
@@ -56,6 +56,7 @@ configure specific aspects of kernel behavior to your liking. initrd cgroup-v2 + cgroup-v1/index serial-console braille-console parport
@@ -74,9 +75,31 @@ configure specific aspects of kernel behavior to your liking. thunderbolt LSM/index mm/index + aoe/index perf-security acpi/index + btmrvl + clearing-warn-once + cpu-load + cputopology + highuid + hw_random + ldm + pnp + rtc + video-output + efi-stub + iostats + kernel-per-cpu-kthreads + lcd-panel-cgram + lockup-watchdogs + mm/cma_debugfs + numastat + svga + + + .. only:: subproject and html Indices
Documentation/admin-guide/iostats.rst renamed from Documentation/iostats.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ===================== I/O statistics fields =====================
Documentation/admin-guide/kernel-parameters.txt +3 -3
@@ -4098,7 +4098,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>,...]
@@ -4608,7 +4608,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 }
@@ -5075,7 +5075,7 @@ vga= [BOOT,X86-32] Select a particular video mode See Documentation/x86/boot.rst and - Documentation/svga.rst. + 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.rst +1 -3
@@ -1,5 +1,3 @@ -:orphan: - ========================================== Reducing OS jitter due to per-cpu kthreads ==========================================
@@ -14,7 +12,7 @@ References - Documentation/IRQ-affinity.rst: 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/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.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ========================================== LDM - Logical Disk Manager (Dynamic Disks) ==========================================
Documentation/admin-guide/lockup-watchdogs.rst renamed from Documentation/lockup-watchdogs.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =============================================================== Softlockup detector and hardlockup detector (aka nmi_watchdog) ===============================================================
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/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/admin-guide/numastat.rst renamed from Documentation/numastat.rst +1 -3
@@ -1,5 +1,3 @@ -:orphan: - =============================== Numa policy hit/miss statistics ===============================
@@ -22,7 +20,7 @@ local_node A process ran on this node and got memory from it. other_node A process ran on this node and got memory from another node. -interleave_hit Interleaving wanted to allocate from this node +interleave_hit Interleaving wanted to allocate from this node and succeeded. =============== ============================================================
Documentation/admin-guide/pnp.rst renamed from Documentation/pnp.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================================= Linux Plug and Play Documentation =================================
Documentation/admin-guide/rtc.rst renamed from Documentation/rtc.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ======================================= Real Time Clock (RTC) Drivers for Linux =======================================
Documentation/admin-guide/svga.rst renamed from Documentation/svga.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - .. include:: <isonum.txt> =================================
Documentation/admin-guide/video-output.rst renamed from Documentation/video-output.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - Video Output Switcher Control ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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_DEBUG_BLK_CGROUP 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_DEBUG_BLK_CGROUP is not set, then bfq creates only the files:: blkio.bfq.io_service_bytes
Documentation/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.rst). 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.rst 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/driver-api/index.rst +1 -1
@@ -29,8 +29,8 @@ available subsections can be seen below. regulator iio/index input - usb/index firewire + usb/index pci/index spi i2c
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.rst 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/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/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/sysctl/kernel.rst +1 -1
@@ -343,7 +343,7 @@ when a hard lockup is detected. 0 - don't panic on hard lockup 1 - panic on hard lockup -See Documentation/lockup-watchdogs.rst 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/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/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.rst. 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.
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 +9 -9
@@ -2651,7 +2651,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
@@ -4105,7 +4105,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/
@@ -4116,7 +4116,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
@@ -6038,7 +6038,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.rst +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
@@ -7006,7 +7006,7 @@ M: Herbert Xu <[email protected]> L: [email protected] S: Odd fixes F: Documentation/devicetree/bindings/rng/ -F: Documentation/hw_random.rst +F: Documentation/admin-guide/hw_random.rst F: drivers/char/hw_random/ F: include/linux/hw_random.h
@@ -9296,7 +9296,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.rst +F: Documentation/admin-guide/ldm.rst F: block/partitions/ldm.* LSILOGIC MPT FUSION DRIVERS (FC/SAS/SPI)
@@ -11935,7 +11935,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
@@ -13354,7 +13354,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.rst +F: Documentation/admin-guide/rtc.rst F: drivers/rtc/ F: include/linux/rtc.h F: include/uapi/linux/rtc.h
@@ -15174,7 +15174,7 @@ SVGA HANDLING M: Martin Mares <[email protected]> L: [email protected] S: Maintained -F: Documentation/svga.rst +F: Documentation/admin-guide/svga.rst F: arch/x86/boot/video* SWIOTLB SUBSYSTEM
arch/arm/Kconfig +1 -1
@@ -1266,7 +1266,7 @@ config SMP will run faster if you say N here. See also <file:Documentation/x86/i386/IO-APIC.rst>, - <file:Documentation/lockup-watchdogs.rst> 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
@@ -275,7 +275,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.rst> 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
@@ -677,7 +677,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.rst> 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
@@ -179,7 +179,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.rst> 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
@@ -397,7 +397,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.rst> 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.
@@ -1954,7 +1954,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.rst for more information. + See Documentation/admin-guide/efi-stub.rst for more information. config EFI_MIXED bool "EFI mixed-mode support"
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)"
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.rst>. + 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.rst> + 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.rst> + 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.rst 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/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/linux/hw_random.h +1 -1
@@ -1,7 +1,7 @@/* Hardware Random Number Generator -Please read Documentation/hw_random.rst 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
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
@@ -735,7 +735,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.
@@ -797,7 +797,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 DEBUG_BLK_CGROUP bool "IO controller debugging"
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 · 6 lines
2.21.0 _______________________________________________ dri-devel mailing list [email protected] https://lists.freedesktop.org/mailman/listinfo/dri-devel
PATCH 12/22 docs: driver-api: add .rst files from the main dir
In reply to Mauro Carvalho ChehabThose files belong to the driver-api guide. Add them to the driver-api book.
---
I had to remove the long list of maintainers got by getpatch.pl, as it was too long. I opted to keep only the mailing lists.
Documentation/ABI/removed/sysfs-class-rfkill | 2 +-
Documentation/ABI/stable/sysfs-class-rfkill | 2 +-
.../ABI/testing/sysfs-class-switchtec | 2 +-
Documentation/PCI/pci.rst | 2 +-
Documentation/admin-guide/hw-vuln/l1tf.rst | 2 +-
.../admin-guide/kernel-parameters.txt | 4 +-
.../admin-guide/kernel-per-cpu-kthreads.rst | 2 +-
.../{ => driver-api}/atomic_bitops.rst | 2 -
Documentation/{ => driver-api}/bt8xxgpio.rst | 2 -
.../bus-virt-phys-mapping.rst | 2 -
.../{connector => driver-api}/connector.rst | 2 -
.../{console => driver-api}/console.rst | 2 -
Documentation/{ => driver-api}/crc32.rst | 2 -
Documentation/{ => driver-api}/dcdbas.rst | 2 -
.../{ => driver-api}/debugging-modules.rst | 2 -
.../debugging-via-ohci1394.rst | 2 -
Documentation/{ => driver-api}/dell_rbu.rst | 2 -
Documentation/{ => driver-api}/digsig.rst | 2 -
.../{EDID/howto.rst => driver-api/edid.rst} | 2 -
Documentation/{ => driver-api}/eisa.rst | 2 -
.../{ => driver-api}/futex-requeue-pi.rst | 2 -
.../{ => driver-api}/gcc-plugins.rst | 2 -
Documentation/{ => driver-api}/hwspinlock.rst | 2 -
Documentation/driver-api/index.rst | 66 +++++++++++++++++++
Documentation/{ => driver-api}/io-mapping.rst | 2 -
.../{ => driver-api}/io_ordering.rst | 2 -
.../{IPMI.rst => driver-api/ipmi.rst} | 2 -
.../irq-affinity.rst} | 2 -
.../irq-domain.rst} | 2 -
Documentation/{IRQ.rst => driver-api/irq.rst} | 2 -
.../{ => driver-api}/irqflags-tracing.rst | 2 -
Documentation/{ => driver-api}/isa.rst | 2 -
Documentation/{ => driver-api}/isapnp.rst | 2 -
Documentation/{ => driver-api}/kobject.rst | 4 +-
Documentation/{ => driver-api}/kprobes.rst | 2 -
Documentation/{ => driver-api}/kref.rst | 2 -
.../pblk.txt => driver-api/lightnvm-pblk.rst} | 0
Documentation/{ => driver-api}/lzo.rst | 2 -
Documentation/{ => driver-api}/mailbox.rst | 2 -
.../{ => driver-api}/men-chameleon-bus.rst | 2 -
Documentation/{ => driver-api}/nommu-mmap.rst | 2 -
Documentation/{ => driver-api}/ntb.rst | 2 -
Documentation/{nvmem => driver-api}/nvmem.rst | 2 -
Documentation/{ => driver-api}/padata.rst | 2 -
.../{ => driver-api}/parport-lowlevel.rst | 2 -
.../{ => driver-api}/percpu-rw-semaphore.rst | 2 -
Documentation/{ => driver-api}/pi-futex.rst | 2 -
Documentation/driver-api/pps.rst | 2 -
.../{ => driver-api}/preempt-locking.rst | 2 -
.../{pti => driver-api}/pti_intel_mid.rst | 2 -
Documentation/driver-api/ptp.rst | 2 -
Documentation/{ => driver-api}/pwm.rst | 2 -
Documentation/{ => driver-api}/rbtree.rst | 2 -
Documentation/{ => driver-api}/remoteproc.rst | 4 +-
Documentation/{ => driver-api}/rfkill.rst | 2 -
.../{ => driver-api}/robust-futex-ABI.rst | 2 -
.../{ => driver-api}/robust-futexes.rst | 2 -
Documentation/{ => driver-api}/rpmsg.rst | 2 -
Documentation/{ => driver-api}/sgi-ioc4.rst | 2 -
.../{SM501.rst => driver-api/sm501.rst} | 2 -
.../{ => driver-api}/smsc_ece1099.rst | 2 -
.../{ => driver-api}/speculation.rst | 8 +--
.../{ => driver-api}/static-keys.rst | 2 -
Documentation/{ => driver-api}/switchtec.rst | 4 +-
Documentation/{ => driver-api}/sync_file.rst | 2 -
Documentation/{ => driver-api}/tee.rst | 2 -
.../{ => driver-api}/this_cpu_ops.rst | 2 -
.../unaligned-memory-access.rst | 2 -
.../{ => driver-api}/vfio-mediated-device.rst | 4 +-
Documentation/{ => driver-api}/vfio.rst | 2 -
Documentation/{ => driver-api}/xillybus.rst | 2 -
Documentation/{ => driver-api}/xz.rst | 2 -
Documentation/{ => driver-api}/zorro.rst | 2 -
Documentation/driver-model/device.rst | 2 +-
Documentation/fb/fbcon.rst | 4 +-
Documentation/filesystems/sysfs.txt | 2 +-
Documentation/gpu/drm-mm.rst | 2 +-
Documentation/ia64/irq-redir.rst | 2 +-
Documentation/laptops/thinkpad-acpi.rst | 6 +-
Documentation/locking/rt-mutex.rst | 2 +-
Documentation/networking/scaling.rst | 4 +-
Documentation/s390/vfio-ccw.rst | 6 +-
Documentation/sysctl/kernel.rst | 2 +-
Documentation/sysctl/vm.rst | 2 +-
Documentation/trace/kprobetrace.rst | 2 +-
Documentation/translations/zh_CN/IRQ.txt | 4 +-
.../translations/zh_CN/filesystems/sysfs.txt | 2 +-
.../translations/zh_CN/io_ordering.txt | 4 +-
Documentation/w1/w1.netlink | 2 +-
Documentation/watchdog/hpwdt.rst | 2 +-
MAINTAINERS | 46 ++++++-------
arch/Kconfig | 4 +-
arch/unicore32/include/asm/io.h | 2 +-
drivers/base/core.c | 2 +-
drivers/char/ipmi/Kconfig | 2 +-
drivers/char/ipmi/ipmi_si_hotmod.c | 2 +-
drivers/char/ipmi/ipmi_si_intf.c | 2 +-
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 +-
include/asm-generic/bitops/atomic.h | 2 +-
include/linux/io-mapping.h | 2 +-
include/linux/jump_label.h | 2 +-
include/linux/kobject.h | 2 +-
include/linux/kobject_ns.h | 2 +-
include/linux/rbtree.h | 2 +-
include/linux/rbtree_augmented.h | 2 +-
init/Kconfig | 2 +-
kernel/padata.c | 2 +-
lib/Kconfig | 2 +-
lib/Kconfig.debug | 2 +-
lib/crc32.c | 2 +-
lib/kobject.c | 4 +-
lib/lzo/lzo1x_decompress_safe.c | 2 +-
lib/xz/Kconfig | 2 +-
mm/Kconfig | 2 +-
mm/nommu.c | 2 +-
samples/Kconfig | 2 +-
samples/kprobes/kprobe_example.c | 2 +-
samples/kprobes/kretprobe_example.c | 2 +-
scripts/gcc-plugins/Kconfig | 2 +-
tools/include/linux/rbtree.h | 2 +-
tools/include/linux/rbtree_augmented.h | 2 +-
132 files changed, 173 insertions(+), 235 deletions(-)
rename Documentation/{ => driver-api}/atomic_bitops.rst (99%)
rename Documentation/{ => driver-api}/bt8xxgpio.rst (99%)
rename Documentation/{ => driver-api}/bus-virt-phys-mapping.rst (99%)
rename Documentation/{connector => driver-api}/connector.rst (99%)
rename Documentation/{console => driver-api}/console.rst (99%)
rename Documentation/{ => driver-api}/crc32.rst (99%)
rename Documentation/{ => driver-api}/dcdbas.rst (99%)
rename Documentation/{ => driver-api}/debugging-modules.rst (98%)
rename Documentation/{ => driver-api}/debugging-via-ohci1394.rst (99%)
rename Documentation/{ => driver-api}/dell_rbu.rst (99%)
rename Documentation/{ => driver-api}/digsig.rst (99%)
rename Documentation/{EDID/howto.rst => driver-api/edid.rst} (99%)
rename Documentation/{ => driver-api}/eisa.rst (99%)
rename Documentation/{ => driver-api}/futex-requeue-pi.rst (99%)
rename Documentation/{ => driver-api}/gcc-plugins.rst (99%)
rename Documentation/{ => driver-api}/hwspinlock.rst (99%)
rename Documentation/{ => driver-api}/io-mapping.rst (99%)
rename Documentation/{ => driver-api}/io_ordering.rst (99%)
rename Documentation/{IPMI.rst => driver-api/ipmi.rst} (99%)
rename Documentation/{IRQ-affinity.rst => driver-api/irq-affinity.rst} (99%)
rename Documentation/{IRQ-domain.rst => driver-api/irq-domain.rst} (99%)
rename Documentation/{IRQ.rst => driver-api/irq.rst} (99%)
rename Documentation/{ => driver-api}/irqflags-tracing.rst (99%)
rename Documentation/{ => driver-api}/isa.rst (99%)
rename Documentation/{ => driver-api}/isapnp.rst (98%)
rename Documentation/{ => driver-api}/kobject.rst (99%)
rename Documentation/{ => driver-api}/kprobes.rst (99%)
rename Documentation/{ => driver-api}/kref.rst (99%)
rename Documentation/{lightnvm/pblk.txt => driver-api/lightnvm-pblk.rst} (100%)
rename Documentation/{ => driver-api}/lzo.rst (99%)
rename Documentation/{ => driver-api}/mailbox.rst (99%)
rename Documentation/{ => driver-api}/men-chameleon-bus.rst (99%)
rename Documentation/{ => driver-api}/nommu-mmap.rst (99%)
rename Documentation/{ => driver-api}/ntb.rst (99%)
rename Documentation/{nvmem => driver-api}/nvmem.rst (99%)
rename Documentation/{ => driver-api}/padata.rst (99%)
rename Documentation/{ => driver-api}/parport-lowlevel.rst (99%)
rename Documentation/{ => driver-api}/percpu-rw-semaphore.rst (99%)
rename Documentation/{ => driver-api}/pi-futex.rst (99%)
rename Documentation/{ => driver-api}/preempt-locking.rst (99%)
rename Documentation/{pti => driver-api}/pti_intel_mid.rst (99%)
rename Documentation/{ => driver-api}/pwm.rst (99%)
rename Documentation/{ => driver-api}/rbtree.rst (99%)
rename Documentation/{ => driver-api}/remoteproc.rst (99%)
rename Documentation/{ => driver-api}/rfkill.rst (99%)
rename Documentation/{ => driver-api}/robust-futex-ABI.rst (99%)
rename Documentation/{ => driver-api}/robust-futexes.rst (99%)
rename Documentation/{ => driver-api}/rpmsg.rst (99%)
rename Documentation/{ => driver-api}/sgi-ioc4.rst (99%)
rename Documentation/{SM501.rst => driver-api/sm501.rst} (99%)
rename Documentation/{ => driver-api}/smsc_ece1099.rst (99%)
rename Documentation/{ => driver-api}/speculation.rst (99%)
rename Documentation/{ => driver-api}/static-keys.rst (99%)
rename Documentation/{ => driver-api}/switchtec.rst (97%)
rename Documentation/{ => driver-api}/sync_file.rst (99%)
rename Documentation/{ => driver-api}/tee.rst (99%)
rename Documentation/{ => driver-api}/this_cpu_ops.rst (99%)
rename Documentation/{ => driver-api}/unaligned-memory-access.rst (99%)
rename Documentation/{ => driver-api}/vfio-mediated-device.rst (99%)
rename Documentation/{ => driver-api}/vfio.rst (99%)
rename Documentation/{ => driver-api}/xillybus.rst (99%)
rename Documentation/{ => driver-api}/xz.rst (99%)
rename Documentation/{ => driver-api}/zorro.rst (99%)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.rst. +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.rst. +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.rst. +For details on this subsystem look at Documentation/driver-api/switchtec.rst. What: /sys/class/switchtec Date: 05-Jan-2017
Documentation/PCI/pci.rst +1 -1
@@ -239,7 +239,7 @@ from the PCI device config space. Use the values in the pci_dev structure as the PCI "bus address" might have been remapped to a "host physical" address by the arch/chip-set specific kernel support. -See Documentation/io-mapping.rst for how to access device registers +See Documentation/driver-api/io-mapping.rst for how to access device registers or device memory. The device driver needs to call pci_request_region() to verify
Documentation/admin-guide/hw-vuln/l1tf.rst +1 -1
@@ -268,7 +268,7 @@ Guest mitigation mechanisms /proc/irq/$NR/smp_affinity[_list] files. Limited documentation is available at: - https://www.kernel.org/doc/Documentation/IRQ-affinity.rst + https://www.kernel.org/doc/Documentation/driver-api/irq-affinity.rst .. _smt_control:
Documentation/admin-guide/kernel-parameters.txt +2 -2
@@ -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
@@ -3162,7 +3162,7 @@ See Documentation/sysctl/vm.rst for details. ohci1394_dma=early [HW] enable debugging via the ohci1394 driver. - See Documentation/debugging-via-ohci1394.rst for more + See Documentation/driver-api/debugging-via-ohci1394.rst for more info. olpc_ec_timeout= [OLPC] ms delay when issuing EC commands
Documentation/admin-guide/kernel-per-cpu-kthreads.rst +1 -1
@@ -10,7 +10,7 @@ them to a "housekeeping" CPU dedicated to such work. References ========== -- Documentation/IRQ-affinity.rst: Binding interrupts to sets of CPUs. +- Documentation/driver-api/irq-affinity.rst: Binding interrupts to sets of CPUs. - Documentation/admin-guide/cgroup-v1: Using cgroups to bind tasks to sets of CPUs.
Documentation/driver-api/atomic_bitops.rst renamed from Documentation/atomic_bitops.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============= Atomic bitops =============
Documentation/driver-api/bt8xxgpio.rst renamed from Documentation/bt8xxgpio.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =================================================================== A driver for a selfmade cheap BT8xx based PCI GPIO-card (bt8xxgpio) ===================================================================
Documentation/driver-api/bus-virt-phys-mapping.rst renamed from Documentation/bus-virt-phys-mapping.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ========================================================== How to access I/O mapped memory from within device drivers ==========================================================
Documentation/driver-api/connector.rst renamed from Documentation/connector/connector.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================ Kernel Connector ================
Documentation/driver-api/console.rst renamed from Documentation/console/console.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =============== Console Drivers ===============
Documentation/driver-api/crc32.rst renamed from Documentation/crc32.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================================= brief tutorial on CRC computation =================================
Documentation/driver-api/dcdbas.rst renamed from Documentation/dcdbas.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =================================== Dell Systems Management Base Driver ===================================
Documentation/driver-api/debugging-modules.rst renamed from Documentation/debugging-modules.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - Debugging Modules after 2.6.3 -----------------------------
Documentation/driver-api/debugging-via-ohci1394.rst renamed from Documentation/debugging-via-ohci1394.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =========================================================================== Using physical DMA provided by OHCI-1394 FireWire controllers for debugging ===========================================================================
Documentation/driver-api/dell_rbu.rst renamed from Documentation/dell_rbu.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============================================================= Usage of the new open sourced rbu (Remote BIOS Update) driver =============================================================
Documentation/driver-api/digsig.rst renamed from Documentation/digsig.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================================== Digital Signature Verification API ==================================
Documentation/driver-api/edid.rst renamed from Documentation/EDID/howto.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ==== EDID ====
Documentation/driver-api/eisa.rst renamed from Documentation/eisa.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================ EISA bus support ================
Documentation/driver-api/futex-requeue-pi.rst renamed from Documentation/futex-requeue-pi.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================ Futex Requeue PI ================
Documentation/driver-api/gcc-plugins.rst renamed from Documentation/gcc-plugins.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ========================= GCC plugin infrastructure =========================
Documentation/driver-api/hwspinlock.rst renamed from Documentation/hwspinlock.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =========================== Hardware Spinlock Framework ===========================
Documentation/driver-api/index.rst +66 -0
72 lines not on this page · raw message
Documentation/driver-api/io-mapping.rst renamed from Documentation/io-mapping.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ======================== The io_mapping functions ========================
Documentation/driver-api/io_ordering.rst renamed from Documentation/io_ordering.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============================================== Ordering I/O writes to memory-mapped addresses ==============================================
Documentation/driver-api/ipmi.rst renamed from Documentation/IPMI.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ===================== The Linux IPMI Driver =====================
Documentation/driver-api/irq-affinity.rst renamed from Documentation/IRQ-affinity.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================ SMP IRQ affinity ================
Documentation/driver-api/irq-domain.rst renamed from Documentation/IRQ-domain.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =============================================== The irq_domain interrupt number mapping library ===============================================
Documentation/driver-api/irq.rst renamed from Documentation/IRQ.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =============== What is an IRQ? ===============
Documentation/driver-api/irqflags-tracing.rst renamed from Documentation/irqflags-tracing.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ======================= IRQ-flags state tracing =======================
Documentation/driver-api/isa.rst renamed from Documentation/isa.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =========== ISA Drivers ===========
Documentation/driver-api/isapnp.rst renamed from Documentation/isapnp.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ========================================================== ISA Plug & Play support by Jaroslav Kysela <[email protected]> ==========================================================
Documentation/driver-api/kobject.rst renamed from Documentation/kobject.rst +1 -3
@@ -1,5 +1,3 @@ -:orphan: - ===================================================================== Everything you never wanted to know about kobjects, ksets, and ktypes =====================================================================
@@ -212,7 +210,7 @@ statically and will warn the developer of this improper usage. If all that you want to use a kobject for is to provide a reference counter for your structure, please use the struct kref instead; a kobject would be overkill. For more information on how to use struct kref, please see the -file Documentation/kref.rst in the Linux kernel source tree. +file Documentation/driver-api/kref.rst in the Linux kernel source tree. Creating "simple" kobjects
Documentation/driver-api/kprobes.rst renamed from Documentation/kprobes.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ======================= Kernel Probes (Kprobes) =======================
Documentation/driver-api/kref.rst renamed from Documentation/kref.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =================================================== Adding reference counters (krefs) to kernel objects ===================================================
Documentation/driver-api/lightnvm-pblk.rst renamed from Documentation/lightnvm/pblk.txt +0 -0
Documentation/driver-api/lzo.rst renamed from Documentation/lzo.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =========================================================== LZO stream format as understood by Linux's LZO decompressor ===========================================================
Documentation/driver-api/mailbox.rst renamed from Documentation/mailbox.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============================ The Common Mailbox Framework ============================
Documentation/driver-api/men-chameleon-bus.rst renamed from Documentation/men-chameleon-bus.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================= MEN Chameleon Bus =================
Documentation/driver-api/nommu-mmap.rst renamed from Documentation/nommu-mmap.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============================= No-MMU memory mapping support =============================
Documentation/driver-api/ntb.rst renamed from Documentation/ntb.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =========== NTB Drivers ===========
Documentation/driver-api/nvmem.rst renamed from Documentation/nvmem/nvmem.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =============== NVMEM Subsystem ===============
Documentation/driver-api/padata.rst renamed from Documentation/padata.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ======================================= The padata parallel execution mechanism =======================================
Documentation/driver-api/parport-lowlevel.rst renamed from Documentation/parport-lowlevel.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =============================== PARPORT interface documentation ===============================
Documentation/driver-api/percpu-rw-semaphore.rst renamed from Documentation/percpu-rw-semaphore.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ==================== Percpu rw semaphores ====================
Documentation/driver-api/pi-futex.rst renamed from Documentation/pi-futex.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ====================== Lightweight PI-futexes ======================
Documentation/driver-api/pps.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ====================== PPS - Pulse Per Second ======================
Documentation/driver-api/preempt-locking.rst renamed from Documentation/preempt-locking.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =========================================================================== Proper Locking Under a Preemptible Kernel: Keeping Kernel Code Preempt-Safe ===========================================================================
Documentation/driver-api/pti_intel_mid.rst renamed from Documentation/pti/pti_intel_mid.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============= Intel MID PTI =============
Documentation/driver-api/ptp.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =========================================== PTP hardware clock infrastructure for Linux ===========================================
Documentation/driver-api/pwm.rst renamed from Documentation/pwm.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ====================================== Pulse Width Modulation (PWM) interface ======================================
Documentation/driver-api/rbtree.rst renamed from Documentation/rbtree.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================================= Red-black Trees (rbtree) in Linux =================================
Documentation/driver-api/remoteproc.rst renamed from Documentation/remoteproc.rst +1 -3
@@ -1,5 +1,3 @@ -:orphan: - ========================== Remote Processor Framework ==========================
@@ -24,7 +22,7 @@ for remote processors that supports this kind of communication. This way, platform-specific remoteproc drivers only need to provide a few low-level handlers, and then all rpmsg drivers will then just work (for more information about the virtio-based rpmsg bus and its drivers, -please read Documentation/rpmsg.rst). +please read Documentation/driver-api/rpmsg.rst). Registration of other types of virtio devices is now also possible. Firmwares just need to publish what kind of virtio devices do they support, and then remoteproc will add those devices. This makes it possible to reuse the
Documentation/driver-api/rfkill.rst renamed from Documentation/rfkill.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =============================== rfkill - RF kill switch support ===============================
Documentation/driver-api/robust-futex-ABI.rst renamed from Documentation/robust-futex-ABI.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ==================== The robust futex ABI ====================
Documentation/driver-api/robust-futexes.rst renamed from Documentation/robust-futexes.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ======================================== A description of what robust futexes are ========================================
Documentation/driver-api/rpmsg.rst renamed from Documentation/rpmsg.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============================================ Remote Processor Messaging (rpmsg) Framework ============================================
Documentation/driver-api/sgi-ioc4.rst renamed from Documentation/sgi-ioc4.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ==================================== SGI IOC4 PCI (multi function) device ====================================
Documentation/driver-api/sm501.rst renamed from Documentation/SM501.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - .. include:: <isonum.txt> ============
Documentation/driver-api/smsc_ece1099.rst renamed from Documentation/smsc_ece1099.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================================================= Msc Keyboard Scan Expansion/GPIO Expansion device =================================================
Documentation/driver-api/speculation.rst renamed from Documentation/speculation.rst +3 -5
@@ -1,12 +1,10 @@ -:orphan: +=========== +Speculation +=========== This document explains potential effects of speculation, and how undesirable effects can be mitigated portably using common APIs. -=========== -Speculation -=========== - To improve performance and minimize average latencies, many contemporary CPUs employ speculative execution techniques such as branch prediction, performing work which may be discarded at a later stage.
Documentation/driver-api/static-keys.rst renamed from Documentation/static-keys.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =========== Static Keys ===========
Documentation/driver-api/switchtec.rst renamed from Documentation/switchtec.rst +1 -3
@@ -1,5 +1,3 @@ -:orphan: - ======================== Linux Switchtec Support ========================
@@ -99,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.rst 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.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =================== Sync File API Guide ===================
Documentation/driver-api/tee.rst renamed from Documentation/tee.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============= TEE subsystem =============
Documentation/driver-api/this_cpu_ops.rst renamed from Documentation/this_cpu_ops.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =================== this_cpu operations ===================
Documentation/driver-api/unaligned-memory-access.rst renamed from Documentation/unaligned-memory-access.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ========================= Unaligned Memory Accesses =========================
Documentation/driver-api/vfio-mediated-device.rst renamed from Documentation/vfio-mediated-device.rst +1 -3
@@ -1,5 +1,3 @@ -:orphan: - .. include:: <isonum.txt> =====================
@@ -410,7 +408,7 @@ card. References ========== -1. See Documentation/vfio.rst 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.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================================== VFIO - "Virtual Function I/O" [1]_ ==================================
Documentation/driver-api/xillybus.rst renamed from Documentation/xillybus.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ========================================== Xillybus driver for generic FPGA interface ==========================================
Documentation/driver-api/xz.rst renamed from Documentation/xz.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============================ XZ data compression in Linux ============================
Documentation/driver-api/zorro.rst renamed from Documentation/zorro.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ======================================== Writing Device Drivers for Zorro Devices ========================================
Documentation/driver-model/device.rst +1 -1
@@ -53,7 +53,7 @@ Attributes of devices can be exported by a device driver through sysfs. Please see Documentation/filesystems/sysfs.txt for more information on how sysfs works. -As explained in Documentation/kobject.rst, device attributes must be +As explained in Documentation/driver-api/kobject.rst, device attributes must be created before the KOBJ_ADD uevent is generated. The only way to realize that is by defining an attribute group.
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/filesystems/sysfs.txt +1 -1
@@ -16,7 +16,7 @@ a means to export kernel data structures, their attributes, and the linkages between them to userspace. sysfs is tied inherently to the kobject infrastructure. Please read -Documentation/kobject.rst for more information concerning the kobject +Documentation/driver-api/kobject.rst for more information concerning the kobject interface.
Documentation/gpu/drm-mm.rst +1 -1
@@ -320,7 +320,7 @@ struct :c:type:`struct file_operations <file_operations>` get_unmapped_area field with a pointer on :c:func:`drm_gem_cma_get_unmapped_area`. More detailed information about get_unmapped_area can be found in -Documentation/nommu-mmap.rst +Documentation/driver-api/nommu-mmap.rst Memory Coherency ----------------
Documentation/ia64/irq-redir.rst +1 -1
@@ -7,7 +7,7 @@ IRQ affinity on IA64 platforms By writing to /proc/irq/IRQ#/smp_affinity the interrupt routing can be controlled. The behavior on IA64 platforms is slightly different from -that described in Documentation/IRQ-affinity.rst for i386 systems. +that described in Documentation/driver-api/irq-affinity.rst for i386 systems. Because of the usage of SAPIC mode and physical destination mode the IRQ target is one particular CPU and cannot be a mask of several
Documentation/laptops/thinkpad-acpi.rst +3 -3
@@ -643,7 +643,7 @@ Sysfs notes 2010. rfkill controller switch "tpacpi_bluetooth_sw": refer to - Documentation/rfkill.rst 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.rst 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.rst for details. + Documentation/driver-api/rfkill.rst for details. Adaptive keyboard -----------------
Documentation/locking/rt-mutex.rst +1 -1
@@ -4,7 +4,7 @@ RT-mutex subsystem with PI support RT-mutexes with priority inheritance are used to support PI-futexes, which enable pthread_mutex_t priority inheritance attributes -(PTHREAD_PRIO_INHERIT). [See Documentation/pi-futex.rst for more details +(PTHREAD_PRIO_INHERIT). [See Documentation/driver-api/pi-futex.rst for more details about PI-futexes.] This technology was developed in the -rt tree and streamlined for
Documentation/networking/scaling.rst +2 -2
@@ -81,7 +81,7 @@ of queues to IRQs can be determined from /proc/interrupts. By default, an IRQ may be handled on any CPU. Because a non-negligible part of packet processing takes place in receive interrupt handling, it is advantageous to spread receive interrupts between CPUs. To manually adjust the IRQ -affinity of each interrupt see Documentation/IRQ-affinity.rst. Some systems +affinity of each interrupt see Documentation/driver-api/irq-affinity.rst. Some systems will be running irqbalance, a daemon that dynamically optimizes IRQ assignments and as a result may override any manual settings.
@@ -160,7 +160,7 @@ can be configured for each receive queue using a sysfs file entry:: This file implements a bitmap of CPUs. RPS is disabled when it is zero (the default), in which case packets are processed on the interrupting -CPU. Documentation/IRQ-affinity.rst explains how CPUs are assigned to +CPU. Documentation/driver-api/irq-affinity.rst explains how CPUs are assigned to the bitmap.
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.rst +- 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.rst -6. Documentation/vfio-mediated-device.rst +5. Documentation/driver-api/vfio.rst +6. Documentation/driver-api/vfio-mediated-device.rst
Documentation/sysctl/kernel.rst +1 -1
@@ -50,7 +50,7 @@ show up in /proc/sys/kernel: - kexec_load_disabled - kptr_restrict - l2cr [ PPC only ] -- modprobe ==> Documentation/debugging-modules.rst +- modprobe ==> Documentation/driver-api/debugging-modules.rst - modules_disabled - msg_next_id [ sysv ipc ] - msgmax
Documentation/sysctl/vm.rst +1 -1
@@ -580,7 +580,7 @@ trimming of allocations is initiated. The default value is 1. -See Documentation/nommu-mmap.rst for more information. +See Documentation/driver-api/nommu-mmap.rst for more information. numa_zonelist_order
Documentation/trace/kprobetrace.rst +1 -1
@@ -40,7 +40,7 @@ Synopsis of kprobe_events MEMADDR : Address where the probe is inserted. MAXACTIVE : Maximum number of instances of the specified function that can be probed simultaneously, or 0 for the default value - as defined in Documentation/kprobes.rst section 1.3.1. + as defined in Documentation/driver-api/kprobes.rst section 1.3.1. FETCHARGS : Arguments. Each probe can have up to 128 args. %REG : Fetch register REG
Documentation/translations/zh_CN/IRQ.txt +2 -2
@@ -1,4 +1,4 @@ -Chinese translated version of Documentation/IRQ.rst +Chinese translated version of Documentation/driver-api/irq.rst If you have any comment or update to the content, please contact the original document maintainer directly. However, if you have a problem
@@ -9,7 +9,7 @@ or if there is a problem with the translation. Maintainer: Eric W. Biederman <[email protected]> Chinese maintainer: Fu Wei <[email protected]> --------------------------------------------------------------------- -Documentation/IRQ.rst 的中文翻译 +Documentation/driver-api/irq.rst 的中文翻译 如果想评论或更新本文的内容,请直接联系原文档的维护者。如果你使用英文 交流有困难的话,也可以向中文版维护者求助。如果本翻译更新不及时或者翻
Documentation/translations/zh_CN/filesystems/sysfs.txt +1 -1
@@ -40,7 +40,7 @@ sysfs 是一个最初基于 ramfs 且位于内存的文件系统。它提供导 数据结构及其属性,以及它们之间的关联到用户空间的方法。 sysfs 始终与 kobject 的底层结构紧密相关。请阅读 -Documentation/kobject.rst 文档以获得更多关于 kobject 接口的 +Documentation/driver-api/kobject.rst 文档以获得更多关于 kobject 接口的 信息。
Documentation/translations/zh_CN/io_ordering.txt +2 -2
@@ -1,4 +1,4 @@ -Chinese translated version of Documentation/io_ordering.rst +Chinese translated version of Documentation/driver-api/io_ordering.rst If you have any comment or update to the content, please contact the original document maintainer directly. However, if you have a problem
@@ -8,7 +8,7 @@ or if there is a problem with the translation. Chinese maintainer: Lin Yongting <[email protected]> --------------------------------------------------------------------- -Documentation/io_ordering.rst 的中文翻译 +Documentation/driver-api/io_ordering.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.
Documentation/watchdog/hpwdt.rst +1 -1
@@ -44,7 +44,7 @@ Last reviewed: 08/20/2018 NOTE: More information about watchdog drivers in general, including the ioctl interface to /dev/watchdog can be found in - Documentation/watchdog/watchdog-api.rst and Documentation/IPMI.rst. + Documentation/watchdog/watchdog-api.rst and Documentation/driver-api/ipmi.rst. Due to limitations in the iLO hardware, the NMI pretimeout if enabled, can only be set to 9 seconds. Attempts to set pretimeout to other
MAINTAINERS +23 -23
184 lines not on this page · raw message
arch/Kconfig +2 -2
@@ -141,7 +141,7 @@ config HAVE_64BIT_ALIGNED_ACCESS accesses are required to be 64 bit aligned in this way even though it is not a 64 bit architecture. - See Documentation/unaligned-memory-access.rst for more + See Documentation/driver-api/unaligned-memory-access.rst for more information on the topic of unaligned memory accesses. config HAVE_EFFICIENT_UNALIGNED_ACCESS
@@ -160,7 +160,7 @@ config HAVE_EFFICIENT_UNALIGNED_ACCESS problems with received packets if doing so would not help much. - See Documentation/unaligned-memory-access.rst for more + See Documentation/driver-api/unaligned-memory-access.rst for more information on the topic of unaligned memory accesses. config ARCH_USE_BUILTIN_BSWAP
arch/unicore32/include/asm/io.h +1 -1
@@ -31,7 +31,7 @@ extern void __uc32_iounmap(volatile void __iomem *addr);* ioremap and friends. * * ioremap takes a PCI memory address, as specified in -* Documentation/io-mapping.rst. +* Documentation/driver-api/io-mapping.rst. * */ #define ioremap (cookie, size) __uc32_ioremap(cookie, size)
drivers/base/core.c +1 -1
@@ -1063,7 +1063,7 @@ static void device_release(struct kobject *kobj)else if (dev->class && dev->class->dev_release) dev->class->dev_release (dev);else -WARN (1 ,KERN_ERR "Device '%s' does not have a release() function, it is broken and must be fixed. See Documentation/kobject.rst.\n" , +WARN (1 ,KERN_ERR "Device '%s' does not have a release() function, it is broken and must be fixed. See Documentation/driver-api/kobject.rst.\n" ,dev_name (dev));kfree (p); }
drivers/char/ipmi/Kconfig +1 -1
@@ -14,7 +14,7 @@ menuconfig IPMI_HANDLER IPMI is a standard for managing sensors (temperature, voltage, etc.) in a system. - See <file:Documentation/IPMI.rst> for more details on the driver. + See <file:Documentation/driver-api/ipmi.rst> for more details on the driver. If unsure, say N.
drivers/char/ipmi/ipmi_si_hotmod.c +1 -1
@@ -18,7 +18,7 @@ static int hotmod_handler(const char *val, const struct kernel_param *kp);module_param_call (hotmod, hotmod_handler,NULL ,NULL ,0200 );MODULE_PARM_DESC (hotmod,"Add and remove interfaces. See" -" Documentation/IPMI.rst in the kernel sources for the" +" Documentation/driver-api/ipmi.rst in the kernel sources for the" " gory details." );/*
drivers/char/ipmi/ipmi_si_intf.c +1 -1
@@ -977,7 +977,7 @@ static inline int ipmi_thread_busy_wait(enum si_sm_result smi_result,* that are not BT and do not have interrupts. It starts spinning * when an operation is complete or until max_busy tells it to stop * (if that is enabled). See the paragraph on kimid_max_busy_us in -* Documentation/IPMI.rst for details. +* Documentation/driver-api/ipmi.rst for details. */ static int ipmi_thread (void *data) {
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.rst. + 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.rst + 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.rst> 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.rst> 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.rst> 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.rst 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.rst 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.rst>. + 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.rst 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.rst 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.
include/asm-generic/bitops/atomic.h +1 -1
@@ -8,7 +8,7 @@/* * Implementation of atomic bitops using atomic-fetch ops. -* See Documentation/atomic_bitops.rst for details. +* See Documentation/driver-api/atomic_bitops.rst for details. */ static inline void set_bit (unsigned int nr,volatile unsigned long *p)
include/linux/io-mapping.h +1 -1
@@ -28,7 +28,7 @@* The io_mapping mechanism provides an abstraction for mapping * individual pages from an io device to the CPU in an efficient fashion. * -* See Documentation/io-mapping.rst +* See Documentation/driver-api/io-mapping.rst */ struct io_mapping {
include/linux/jump_label.h +1 -1
@@ -68,7 +68,7 @@* Lacking toolchain and or architecture support, static keys fall back to a * simple conditional branch. * -* Additional babbling in: Documentation/static-keys.rst +* Additional babbling in: Documentation/driver-api/static-keys.rst */ #ifndef __ASSEMBLY__
include/linux/kobject.h +1 -1
@@ -7,7 +7,7 @@* Copyright (c) 2006-2008 Greg Kroah-Hartman <[email protected]> * Copyright (c) 2006-2008 Novell Inc. * -* Please read Documentation/kobject.rst before using the kobject +* Please read Documentation/driver-api/kobject.rst before using the kobject * interface, ESPECIALLY the parts about reference counts and object * destructors. */
include/linux/kobject_ns.h +1 -1
@@ -8,7 +8,7 @@* * Split from kobject.h by David Howells ([email protected]) * -* Please read Documentation/kobject.rst before using the kobject +* Please read Documentation/driver-api/kobject.rst before using the kobject * interface, ESPECIALLY the parts about reference counts and object * destructors. */
include/linux/rbtree.h +1 -1
@@ -11,7 +11,7 @@I know it's not the cleaner way, but in C (not in C++) to get performances and genericity... -See Documentation/rbtree.rst for documentation and samples. +See Documentation/driver-api/rbtree.rst for documentation and samples. */ #ifndef _LINUX_RBTREE_H
include/linux/rbtree_augmented.h +1 -1
@@ -21,7 +21,7 @@* rb_insert_augmented() and rb_erase_augmented() are intended to be public. * The rest are implementation details you are not expected to depend on. * -* See Documentation/rbtree.rst for documentation and samples. +* See Documentation/driver-api/rbtree.rst for documentation and samples. */ struct rb_augment_callbacks {
init/Kconfig +1 -1
@@ -1807,7 +1807,7 @@ config MMAP_ALLOW_UNINITIALIZED userspace. Since that isn't generally a problem on no-MMU systems, it is normally safe to say Y here. - See Documentation/nommu-mmap.rst for more information. + See Documentation/driver-api/nommu-mmap.rst for more information. config SYSTEM_DATA_VERIFICATION def_bool n
kernel/padata.c +1 -1
@@ -2,7 +2,7 @@/* * padata.c - generic interface to process data streams in parallel * -* See Documentation/padata.rst for an api documentation. +* See Documentation/driver-api/padata.rst for an api documentation. * * Copyright (C) 2008, 2009 secunet Security Networks AG * Copyright (C) 2008, 2009 Steffen Klassert <[email protected]>
lib/Kconfig +1 -1
@@ -420,7 +420,7 @@ config INTERVAL_TREE See: - Documentation/rbtree.rst + Documentation/driver-api/rbtree.rst for more information.
lib/Kconfig.debug +1 -1
@@ -1682,7 +1682,7 @@ config PROVIDE_OHCI1394_DMA_INIT This code (~1k) is freed after boot. By then, the firewire stack in charge of the OHCI-1394 controllers should be used instead. - See Documentation/debugging-via-ohci1394.rst for more information. + See Documentation/driver-api/debugging-via-ohci1394.rst for more information. menuconfig RUNTIME_TESTING_MENU bool "Runtime Testing"
lib/crc32.c +1 -1
@@ -24,7 +24,7 @@* Version 2. See the file COPYING for more details. */ -/* see: Documentation/crc32.rst for a description of algorithms */ +/* see: Documentation/driver-api/crc32.rst for a description of algorithms */ #include <linux/crc32.h> #include <linux/crc32poly.h>
lib/kobject.c +2 -2
@@ -6,7 +6,7 @@* Copyright (c) 2006-2007 Greg Kroah-Hartman <[email protected]> * Copyright (c) 2006-2007 Novell Inc. * -* Please see the file Documentation/kobject.rst for critical information +* Please see the file Documentation/driver-api/kobject.rst for critical information * about using the kobject interface. */
@@ -668,7 +668,7 @@ static void kobject_cleanup(struct kobject *kobj) kobject_name(kobj), kobj, __func__, kobj->parent);if (t && !t->release) -pr_debug ("kobject: '%s' (%p): does not have a release() function, it is broken and must be fixed. See Documentation/kobject.rst.\n" , +pr_debug ("kobject: '%s' (%p): does not have a release() function, it is broken and must be fixed. See Documentation/driver-api/kobject.rst.\n" ,kobject_name (kobj), kobj);/* send "remove" if the caller did not do it but sent "add" */
lib/lzo/lzo1x_decompress_safe.c +1 -1
@@ -32,7 +32,7 @@* depending on the base count. Since the base count is taken from a u8 * and a few bits, it is safe to assume that it will always be lower than * or equal to 2*255, thus we can always prevent any overflow by accepting -* two less 255 steps. See Documentation/lzo.rst for more information. +* two less 255 steps. See Documentation/driver-api/lzo.rst for more information. */ #define MAX_255_COUNT ((((size_t)~0) / 255) - 2)
lib/xz/Kconfig +1 -1
@@ -5,7 +5,7 @@ config XZ_DEC help LZMA2 compression algorithm and BCJ filters are supported using the .xz file format as the container. For integrity checking, - CRC32 is supported. See Documentation/xz.rst for more information. + CRC32 is supported. See Documentation/driver-api/xz.rst for more information. if XZ_DEC
mm/Kconfig +1 -1
@@ -369,7 +369,7 @@ config NOMMU_INITIAL_TRIM_EXCESS This option specifies the initial value of this option. The default of 1 says that all excess pages should be trimmed. - See Documentation/nommu-mmap.rst for more information. + See Documentation/driver-api/nommu-mmap.rst for more information. config TRANSPARENT_HUGEPAGE bool "Transparent Hugepage Support"
mm/nommu.c +1 -1
@@ -5,7 +5,7 @@* Replacement code for mm functions to support CPU's that don't * have any form of memory management unit (thus no virtual memory). * -* See Documentation/nommu-mmap.rst +* See Documentation/driver-api/nommu-mmap.rst * * Copyright (c) 2004-2008 David Howells <[email protected]> * Copyright (c) 2000-2003 David McCullough <[email protected]>
samples/Kconfig +1 -1
@@ -100,7 +100,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_SECCOMP bool "Build seccomp sample code"
samples/kprobes/kprobe_example.c +1 -1
@@ -5,7 +5,7 @@* stack trace and selected registers when _do_fork() is called. * * For more information on theory of operation of kprobes, see -* Documentation/kprobes.rst +* Documentation/driver-api/kprobes.rst * * You will see the trace data in /var/log/messages and on the console * whenever _do_fork() is invoked to create a new process.
samples/kprobes/kretprobe_example.c +1 -1
@@ -11,7 +11,7 @@* If no func_name is specified, _do_fork is instrumented * * For more information on theory of operation of kretprobes, see -* Documentation/kprobes.rst +* Documentation/driver-api/kprobes.rst * * Build and insert the kernel module as done in the kprobe example. * You will see the trace data in /var/log/messages and on the console
scripts/gcc-plugins/Kconfig +1 -1
@@ -23,7 +23,7 @@ config GCC_PLUGINS GCC plugins are loadable modules that provide extra features to the compiler. They are useful for runtime instrumentation and static analysis. - See Documentation/gcc-plugins.rst for details. + See Documentation/driver-api/gcc-plugins.rst for details. menu "GCC plugins" depends on GCC_PLUGINS
tools/include/linux/rbtree.h +1 -1
@@ -11,7 +11,7 @@I know it's not the cleaner way, but in C (not in C++) to get performances and genericity... -See Documentation/rbtree.rst for documentation and samples. +See Documentation/driver-api/rbtree.rst for documentation and samples. */ #ifndef __TOOLS_LINUX_PERF_RBTREE_H
tools/include/linux/rbtree_augmented.h +1 -1
@@ -23,7 +23,7 @@* rb_insert_augmented() and rb_erase_augmented() are intended to be public. * The rest are implementation details you are not expected to depend on. * -* See Documentation/rbtree.rst for documentation and samples. +* See Documentation/driver-api/rbtree.rst for documentation and samples. */ struct rb_augment_callbacks {
Signature · 1 line
2.21.0
PATCH 13/22 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/x86/index.rst | 2 ++
Documentation/{Intel-IOMMU.rst => x86/intel-iommu.rst} | 1 -
Documentation/{ => x86}/intel_txt.rst | 1 -
MAINTAINERS | 2 +-
security/Kconfig | 2 +-
5 files changed, 4 insertions(+), 4 deletions(-)
rename Documentation/{Intel-IOMMU.rst => x86/intel-iommu.rst} (99%)
rename Documentation/{ => x86}/intel_txt.rst (99%)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.rst +0 -1
@@ -1,4 +1,3 @@ -:orphan: =================== Linux IOMMU Support
Documentation/x86/intel_txt.rst renamed from Documentation/intel_txt.rst +0 -1
@@ -1,4 +1,3 @@ -:orphan: ===================== Intel(R) TXT Overview
MAINTAINERS +1 -1
@@ -8208,7 +8208,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.rst +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.rst 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
PATCH 14/22 docs: usb: rename files to .rst and add them to drivers-api
In reply to Mauro Carvalho ChehabWhile there are a mix of things here, most of the stuff were written from Kernel developer's PoV. So, add them to the driver-api book.
A follow up for this patch would be to move documents from there that are specific to sysadmins, adding them to the admin-guide.
---
Documentation/index.rst | 1 +
Documentation/usb/{acm.txt => acm.rst} | 0
.../{authorization.txt => authorization.rst} | 0
.../usb/{chipidea.txt => chipidea.rst} | 0
Documentation/usb/{dwc3.txt => dwc3.rst} | 0
Documentation/usb/{ehci.txt => ehci.rst} | 0
.../usb/{functionfs.txt => functionfs.rst} | 0
...{gadget-testing.txt => gadget-testing.rst} | 4 +-
...adget_configfs.txt => gadget_configfs.rst} | 0
.../usb/{gadget_hid.txt => gadget_hid.rst} | 0
.../{gadget_multi.txt => gadget_multi.rst} | 0
...{gadget_printer.txt => gadget_printer.rst} | 0
.../{gadget_serial.txt => gadget_serial.rst} | 0
Documentation/usb/index.rst | 39 +++++++++++++++++++
.../usb/{iuu_phoenix.txt => iuu_phoenix.rst} | 0
.../{mass-storage.txt => mass-storage.rst} | 0
...{misc_usbsevseg.txt => misc_usbsevseg.rst} | 0
.../usb/{mtouchusb.txt => mtouchusb.rst} | 0
Documentation/usb/{ohci.txt => ohci.rst} | 0
Documentation/usb/{rio.txt => rio.rst} | 0
Documentation/usb/text_files.rst | 29 ++++++++++++++
.../usb/{usb-help.txt => usb-help.rst} | 0
.../usb/{usb-serial.txt => usb-serial.rst} | 0
...{usbip_protocol.txt => usbip_protocol.rst} | 0
Documentation/usb/{usbmon.txt => usbmon.rst} | 0
...-overview.txt => wusb-design-overview.rst} | 0
MAINTAINERS | 12 +++---
drivers/usb/Kconfig | 2 +-
drivers/usb/class/Kconfig | 2 +-
drivers/usb/gadget/Kconfig | 6 +--
drivers/usb/gadget/function/f_mass_storage.c | 2 +-
drivers/usb/gadget/legacy/Kconfig | 6 +--
drivers/usb/host/Kconfig | 2 +-
drivers/usb/misc/Kconfig | 2 +-
drivers/usb/mon/Kconfig | 2 +-
drivers/usb/serial/Kconfig | 10 ++---
drivers/usb/serial/belkin_sa.c | 2 +-
drivers/usb/serial/belkin_sa.h | 2 +-
drivers/usb/serial/cypress_m8.c | 2 +-
drivers/usb/serial/empeg.c | 2 +-
drivers/usb/serial/ftdi_sio.c | 2 +-
drivers/usb/serial/ir-usb.c | 2 +-
drivers/usb/serial/keyspan_pda.c | 2 +-
drivers/usb/serial/omninet.c | 2 +-
drivers/usb/serial/oti6858.c | 2 +-
drivers/usb/serial/pl2303.c | 2 +-
drivers/usb/serial/usb-serial.c | 2 +-
drivers/usb/serial/visor.c | 2 +-
drivers/usb/serial/visor.h | 2 +-
drivers/usb/serial/whiteheat.c | 2 +-
drivers/usb/serial/whiteheat.h | 2 +-
51 files changed, 109 insertions(+), 40 deletions(-)
rename Documentation/usb/{acm.txt => acm.rst} (100%)
rename Documentation/usb/{authorization.txt => authorization.rst} (100%)
rename Documentation/usb/{chipidea.txt => chipidea.rst} (100%)
rename Documentation/usb/{dwc3.txt => dwc3.rst} (100%)
rename Documentation/usb/{ehci.txt => ehci.rst} (100%)
rename Documentation/usb/{functionfs.txt => functionfs.rst} (100%)
rename Documentation/usb/{gadget-testing.txt => gadget-testing.rst} (99%)
rename Documentation/usb/{gadget_configfs.txt => gadget_configfs.rst} (100%)
rename Documentation/usb/{gadget_hid.txt => gadget_hid.rst} (100%)
rename Documentation/usb/{gadget_multi.txt => gadget_multi.rst} (100%)
rename Documentation/usb/{gadget_printer.txt => gadget_printer.rst} (100%)
rename Documentation/usb/{gadget_serial.txt => gadget_serial.rst} (100%)
create mode 100644 Documentation/usb/index.rst
rename Documentation/usb/{iuu_phoenix.txt => iuu_phoenix.rst} (100%)
rename Documentation/usb/{mass-storage.txt => mass-storage.rst} (100%)
rename Documentation/usb/{misc_usbsevseg.txt => misc_usbsevseg.rst} (100%)
rename Documentation/usb/{mtouchusb.txt => mtouchusb.rst} (100%)
rename Documentation/usb/{ohci.txt => ohci.rst} (100%)
rename Documentation/usb/{rio.txt => rio.rst} (100%)
create mode 100644 Documentation/usb/text_files.rst
rename Documentation/usb/{usb-help.txt => usb-help.rst} (100%)
rename Documentation/usb/{usb-serial.txt => usb-serial.rst} (100%)
rename Documentation/usb/{usbip_protocol.txt => usbip_protocol.rst} (100%)
rename Documentation/usb/{usbmon.txt => usbmon.rst} (100%)
rename Documentation/usb/{WUSB-Design-overview.txt => wusb-design-overview.rst} (100%)Documentation/index.rst +1 -0
@@ -103,6 +103,7 @@ needed). vm/index bpf/index PCI/index + usb/index misc-devices/index Architecture-specific documentation
Documentation/usb/acm.rst renamed from Documentation/usb/acm.txt +0 -0
Documentation/usb/authorization.rst renamed from Documentation/usb/authorization.txt +0 -0
Documentation/usb/chipidea.rst renamed from Documentation/usb/chipidea.txt +0 -0
Documentation/usb/dwc3.rst renamed from Documentation/usb/dwc3.txt +0 -0
Documentation/usb/ehci.rst renamed from Documentation/usb/ehci.txt +0 -0
Documentation/usb/functionfs.rst renamed from Documentation/usb/functionfs.txt +0 -0
Documentation/usb/gadget-testing.rst renamed from Documentation/usb/gadget-testing.txt +2 -2
@@ -254,7 +254,7 @@ Device: - connect the gadget to a host, preferably not the one used to control the gadget - run a program which writes to /dev/hidg<N>, e.g. - a userspace program found in Documentation/usb/gadget_hid.txt:: + a userspace program found in Documentation/usb/gadget_hid.rst:: $ ./hid_gadget_test /dev/hidg0 keyboard
@@ -886,7 +886,7 @@ host:: # cat /dev/usb/lp0 More advanced testing can be done with the prn_example -described in Documentation/usb/gadget_printer.txt. +described in Documentation/usb/gadget_printer.rst. 20. UAC1 function (virtual ALSA card, using u_audio API)
Documentation/usb/gadget_configfs.rst renamed from Documentation/usb/gadget_configfs.txt +0 -0
Documentation/usb/gadget_hid.rst renamed from Documentation/usb/gadget_hid.txt +0 -0
Documentation/usb/gadget_multi.rst renamed from Documentation/usb/gadget_multi.txt +0 -0
Documentation/usb/gadget_printer.rst renamed from Documentation/usb/gadget_printer.txt +0 -0
Documentation/usb/gadget_serial.rst renamed from Documentation/usb/gadget_serial.txt +0 -0
Documentation/usb/index.rst new file +39 -0
@@ -0,0 +1,39 @@ +=========== +USB support +=========== + +.. toctree:: + :maxdepth: 1 + + acm + authorization + chipidea + dwc3 + ehci + functionfs + gadget_configfs + gadget_hid + gadget_multi + gadget_printer + gadget_serial + gadget-testing + iuu_phoenix + mass-storage + misc_usbsevseg + mtouchusb + ohci + rio + usbip_protocol + usbmon + usb-serial + wusb-design-overview + + usb-help + text_files + +.. only:: subproject and html + + Indices + ======= + + * :ref:`genindex`
Documentation/usb/iuu_phoenix.rst renamed from Documentation/usb/iuu_phoenix.txt +0 -0
Documentation/usb/mass-storage.rst renamed from Documentation/usb/mass-storage.txt +0 -0
Documentation/usb/misc_usbsevseg.rst renamed from Documentation/usb/misc_usbsevseg.txt +0 -0
Documentation/usb/mtouchusb.rst renamed from Documentation/usb/mtouchusb.txt +0 -0
Documentation/usb/ohci.rst renamed from Documentation/usb/ohci.txt +0 -0
Documentation/usb/rio.rst renamed from Documentation/usb/rio.txt +0 -0
Documentation/usb/text_files.rst new file +29 -0
@@ -0,0 +1,29 @@ +Linux CDC ACM inf +----------------- + +.. include:: linux-cdc-acm.inf + :literal: + +Linux inf +--------- + +.. include:: linux.inf + :literal: + +USB devfs drop permissions source +--------------------------------- + +.. literalinclude:: usbdevfs-drop-permissions.c + :language: c + +WUSB command line script to manipulate auth credentials +------------------------------------------------------- + +.. literalinclude:: wusb-cbaf + :language: shell + +Credits +------- + +.. include:: CREDITS + :literal:
Documentation/usb/usb-help.rst renamed from Documentation/usb/usb-help.txt +0 -0
Documentation/usb/usb-serial.rst renamed from Documentation/usb/usb-serial.txt +0 -0
Documentation/usb/usbip_protocol.rst renamed from Documentation/usb/usbip_protocol.txt +0 -0
Documentation/usb/usbmon.rst renamed from Documentation/usb/usbmon.txt +0 -0
Documentation/usb/wusb-design-overview.rst renamed from Documentation/usb/WUSB-Design-overview.txt +0 -0
MAINTAINERS +6 -6
@@ -3761,7 +3761,7 @@ F: scripts/extract-cert.c CERTIFIED WIRELESS USB (WUSB) SUBSYSTEM: L: [email protected] S: Orphan -F: Documentation/usb/WUSB-Design-overview.txt +F: Documentation/usb/wusb-design-overview.rst F: Documentation/usb/wusb-cbaf F: drivers/usb/host/hwa-hc.c F: drivers/usb/host/whci/
@@ -16315,7 +16315,7 @@ USB ACM DRIVER M: Oliver Neukum <[email protected]> L: [email protected] S: Maintained -F: Documentation/usb/acm.txt +F: Documentation/usb/acm.rst F: drivers/usb/class/cdc-acm.* USB AR5523 WIRELESS DRIVER
@@ -16368,7 +16368,7 @@ USB EHCI DRIVER M: Alan Stern <[email protected]> L: [email protected] S: Maintained -F: Documentation/usb/ehci.txt +F: Documentation/usb/ehci.rst F: drivers/usb/host/ehci* USB GADGET/PERIPHERAL SUBSYSTEM
@@ -16442,7 +16442,7 @@ USB OHCI DRIVER M: Alan Stern <[email protected]> L: [email protected] S: Maintained -F: Documentation/usb/ohci.txt +F: Documentation/usb/ohci.rst F: drivers/usb/host/ohci* USB OTG FSM (Finite State Machine)
@@ -16458,7 +16458,7 @@ M: Shuah Khan <[email protected]> M: Shuah Khan <[email protected]> L: [email protected] S: Maintained -F: Documentation/usb/usbip_protocol.txt +F: Documentation/usb/usbip_protocol.rst F: drivers/usb/usbip/ F: tools/usb/usbip/ F: tools/testing/selftests/drivers/usb/usbip/
@@ -16506,7 +16506,7 @@ M: Johan Hovold <[email protected]> L: [email protected] T: git git://git.kernel.org/pub/scm/linux/kernel/git/johan/usb-serial.git S: Maintained -F: Documentation/usb/usb-serial.txt +F: Documentation/usb/usb-serial.rst F: drivers/usb/serial/ F: include/linux/usb/serial.h
drivers/usb/Kconfig +1 -1
@@ -75,7 +75,7 @@ config USB After choosing your HCD, then select drivers for the USB peripherals you'll be using. You may want to check out the information provided in <file:Documentation/usb/> and especially the links given in - <file:Documentation/usb/usb-help.txt>. + <file:Documentation/usb/usb-help.rst>. To compile this driver as a module, choose M here: the module will be called usbcore.
drivers/usb/class/Kconfig +1 -1
@@ -10,7 +10,7 @@ config USB_ACM ---help--- This driver supports USB modems and ISDN adapters which support the Communication Device Class Abstract Control Model interface. - Please read <file:Documentation/usb/acm.txt> for details. + Please read <file:Documentation/usb/acm.rst> for details. If your modem only reports "Cls=ff(vend.)" in the descriptors in /sys/kernel/debug/usb/devices, then your modem will not work with this
drivers/usb/gadget/Kconfig +3 -3
@@ -228,7 +228,7 @@ config USB_CONFIGFS specified simply by creating appropriate directories in configfs. Associating functions with configurations is done by creating appropriate symbolic links. - For more information see Documentation/usb/gadget_configfs.txt. + For more information see Documentation/usb/gadget_configfs.rst. config USB_CONFIGFS_SERIAL bool "Generic serial bulk in/out"
@@ -441,7 +441,7 @@ config USB_CONFIGFS_F_HID The HID function driver provides generic emulation of USB Human Interface Devices (HID). - For more information, see Documentation/usb/gadget_hid.txt. + For more information, see Documentation/usb/gadget_hid.rst. config USB_CONFIGFS_F_UVC bool "USB Webcam function"
@@ -466,7 +466,7 @@ config USB_CONFIGFS_F_PRINTER receive or send printer data. It can use ioctl calls to the device file to get or set printer status. - For more information, see Documentation/usb/gadget_printer.txt + For more information, see Documentation/usb/gadget_printer.rst which includes sample code for accessing the device file. config USB_CONFIGFS_F_TCM
drivers/usb/gadget/function/f_mass_storage.c +1 -1
@@ -47,7 +47,7 @@* * For more information about MSF and in particular its module * parameters and sysfs interface read the -* <Documentation/usb/mass-storage.txt> file. +* <Documentation/usb/mass-storage.rst> file. */ /*
drivers/usb/gadget/legacy/Kconfig +3 -3
@@ -287,7 +287,7 @@ config USB_G_SERIAL Say "y" to link the driver statically, or "m" to build a dynamically linked module called "g_serial". - For more information, see Documentation/usb/gadget_serial.txt + For more information, see Documentation/usb/gadget_serial.rst which includes instructions and a "driver info file" needed to make MS-Windows work with CDC ACM.
@@ -321,7 +321,7 @@ config USB_G_PRINTER Say "y" to link the driver statically, or "m" to build a dynamically linked module called "g_printer". - For more information, see Documentation/usb/gadget_printer.txt + For more information, see Documentation/usb/gadget_printer.rst which includes sample code for accessing the device file. if TTY
@@ -436,7 +436,7 @@ config USB_G_HID The HID gadget driver provides generic emulation of USB Human Interface Devices (HID). - For more information, see Documentation/usb/gadget_hid.txt which + For more information, see Documentation/usb/gadget_hid.rst which includes sample code for accessing the device files. Say "y" to link the driver statically, or "m" to build a
drivers/usb/host/Kconfig +1 -1
@@ -114,7 +114,7 @@ config USB_EHCI_HCD Controller Driver or UHCI (for Via motherboards) Host Controller Driver too. - You may want to read <file:Documentation/usb/ehci.txt>. + You may want to read <file:Documentation/usb/ehci.rst>. To compile this driver as a module, choose M here: the module will be called ehci-hcd.
drivers/usb/misc/Kconfig +1 -1
@@ -51,7 +51,7 @@ config USB_RIO500 tristate "USB Diamond Rio500 support" help Say Y here if you want to connect a USB Rio500 mp3 player to your - computer's USB port. Please read <file:Documentation/usb/rio.txt> + computer's USB port. Please read <file:Documentation/usb/rio.rst> for more information. To compile this driver as a module, choose M here: the
drivers/usb/mon/Kconfig +1 -1
@@ -8,6 +8,6 @@ config USB_MON help If you select this option, a component which captures the USB traffic between peripheral-specific drivers and HC drivers will be built. - For more information, see <file:Documentation/usb/usbmon.txt>. + For more information, see <file:Documentation/usb/usbmon.rst>. If unsure, say Y, if allowed, otherwise M.
drivers/usb/serial/Kconfig +5 -5
@@ -11,7 +11,7 @@ menuconfig USB_SERIAL ports, or acts like a serial device, and you want to connect it to your USB bus. - Please read <file:Documentation/usb/usb-serial.txt> for more + Please read <file:Documentation/usb/usb-serial.rst> for more information on the specifics of the different devices that are supported, and on how to use them.
@@ -47,7 +47,7 @@ config USB_SERIAL_GENERIC bool "USB Generic Serial Driver" help Say Y here if you want to use the generic USB serial driver. Please - read <file:Documentation/usb/usb-serial.txt> for more information on + read <file:Documentation/usb/usb-serial.rst> for more information on using this driver. It is recommended that the "USB Serial converter support" be compiled as a module for this driver to be used properly.
@@ -163,7 +163,7 @@ config USB_SERIAL_EMPEG help Say Y here if you want to connect to your Empeg empeg-car Mark I/II mp3 player via USB. The driver uses a single ttyUSB{0,1,2,...} - device node. See <file:Documentation/usb/usb-serial.txt> for more + device node. See <file:Documentation/usb/usb-serial.rst> for more tidbits of information. To compile this driver as a module, choose M here: the
@@ -199,7 +199,7 @@ config USB_SERIAL_IPAQ Say Y here if you want to connect to your Compaq iPAQ, HP Jornada or any other PDA running Windows CE 3.0 or PocketPC 2002 using a USB cradle/cable. For information on using the driver, - read <file:Documentation/usb/usb-serial.txt>. + read <file:Documentation/usb/usb-serial.rst>. To compile this driver as a module, choose M here: the module will be called ipaq.
@@ -334,7 +334,7 @@ config USB_SERIAL_KLSI adapter sold by Palm Inc. for use with their Palm III and Palm V series PDAs. - Please read <file:Documentation/usb/usb-serial.txt> for more + Please read <file:Documentation/usb/usb-serial.rst> for more information. To compile this driver as a module, choose M here: the
drivers/usb/serial/belkin_sa.c +1 -1
@@ -10,7 +10,7 @@* and associated source files. Please see the usb/serial files for * individual credits and copyrights. * -* See Documentation/usb/usb-serial.txt for more information on using this +* See Documentation/usb/usb-serial.rst for more information on using this * driver * * TODO:
drivers/usb/serial/belkin_sa.h +1 -1
@@ -9,7 +9,7 @@* and associated source files. Please see the usb/serial files for * individual credits and copyrights. * -* See Documentation/usb/usb-serial.txt for more information on using this +* See Documentation/usb/usb-serial.rst for more information on using this * driver * * 12-Mar-2001 gkh
drivers/usb/serial/cypress_m8.c +1 -1
@@ -7,7 +7,7 @@* Copyright (C) 2003,2004 * Neil Whelchel ([email protected]) * -* See Documentation/usb/usb-serial.txt for more information on using this +* See Documentation/usb/usb-serial.rst for more information on using this * driver * * See http://geocities.com/i0xox0i for information on this driver and the
drivers/usb/serial/empeg.c +1 -1
@@ -8,7 +8,7 @@* Copyright (C) 1999 - 2001 * Greg Kroah-Hartman ([email protected]) * -* See Documentation/usb/usb-serial.txt for more information on using this +* See Documentation/usb/usb-serial.rst for more information on using this * driver */
drivers/usb/serial/ftdi_sio.c +1 -1
@@ -10,7 +10,7 @@* Copyright (C) 2002 * Kuba Ober ([email protected]) * -* See Documentation/usb/usb-serial.txt for more information on using this +* See Documentation/usb/usb-serial.rst for more information on using this * driver * * See http://ftdi-usb-sio.sourceforge.net for up to date testing info
drivers/usb/serial/ir-usb.c +1 -1
@@ -16,7 +16,7 @@* was written by Roman Weissgaerber <[email protected]>, Dag Brattli * <[email protected]>, and Jean Tourrilhes <[email protected]> * -* See Documentation/usb/usb-serial.txt for more information on using this +* See Documentation/usb/usb-serial.rst for more information on using this * driver */
drivers/usb/serial/keyspan_pda.c +1 -1
@@ -6,7 +6,7 @@* Copyright (C) 1999, 2000 Brian Warner <[email protected]> * Copyright (C) 2000 Al Borchers <[email protected]> * -* See Documentation/usb/usb-serial.txt for more information on using this +* See Documentation/usb/usb-serial.rst for more information on using this * driver */
drivers/usb/serial/omninet.c +1 -1
@@ -4,7 +4,7 @@* * Copyright (C) 2013,2017 Johan Hovold <[email protected]> * -* See Documentation/usb/usb-serial.txt for more information on using this +* See Documentation/usb/usb-serial.rst for more information on using this * driver * * Please report both successes and troubles to the author at [email protected]
drivers/usb/serial/oti6858.c +1 -1
@@ -22,7 +22,7 @@* So, THIS CODE CAN DESTROY OTi-6858 AND ANY OTHER DEVICES, THAT ARE * CONNECTED TO IT! * -* See Documentation/usb/usb-serial.txt for more information on using this +* See Documentation/usb/usb-serial.rst for more information on using this * driver * * TODO:
drivers/usb/serial/pl2303.c +1 -1
@@ -7,7 +7,7 @@* * Original driver for 2.2.x by anonymous * -* See Documentation/usb/usb-serial.txt for more information on using this +* See Documentation/usb/usb-serial.rst for more information on using this * driver */
drivers/usb/serial/usb-serial.c +1 -1
@@ -10,7 +10,7 @@* This driver was originally based on the ACM driver by Armin Fuerst (which was * based on a driver by Brad Keryan) * -* See Documentation/usb/usb-serial.txt for more information on using this +* See Documentation/usb/usb-serial.rst for more information on using this * driver */
drivers/usb/serial/visor.c +1 -1
@@ -6,7 +6,7 @@* Copyright (C) 1999 - 2004 * Greg Kroah-Hartman ([email protected]) * -* See Documentation/usb/usb-serial.txt for more information on using this +* See Documentation/usb/usb-serial.rst for more information on using this * driver * */
drivers/usb/serial/visor.h +1 -1
@@ -5,7 +5,7 @@* Copyright (C) 1999 - 2003 * Greg Kroah-Hartman ([email protected]) * -* See Documentation/usb/usb-serial.txt for more information on using this +* See Documentation/usb/usb-serial.rst for more information on using this * driver. * */
drivers/usb/serial/whiteheat.c +1 -1
@@ -8,7 +8,7 @@* Copyright (C) 1999 - 2001 * Greg Kroah-Hartman ([email protected]) * -* See Documentation/usb/usb-serial.txt for more information on using this +* See Documentation/usb/usb-serial.rst for more information on using this * driver */
drivers/usb/serial/whiteheat.h +1 -1
@@ -8,7 +8,7 @@* Copyright (C) 1999, 2000 * Greg Kroah-Hartman ([email protected]) * -* See Documentation/usb/usb-serial.txt for more information on using this +* See Documentation/usb/usb-serial.rst for more information on using this * driver * */
Signature · 1 line
2.21.0
Re: [PATCH v1 14/22] docs: usb: rename files to .rst and add them to drivers-api
Quoted 9 lines · Mauro Carvalho Chehab
While there are a mix of things here, most of the stuff were written from Kernel developer's PoV. So, add them to the driver-api book.
A follow up for this patch would be to move documents from there that are specific to sysadmins, adding them to the admin-guide.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
Signature · 1 line
balbi
Re: [PATCH v1 14/22] docs: usb: rename files to .rst and add them to drivers-api
In reply to Mauro Carvalho ChehabQuoted 9 lines · Mauro Carvalho Chehab
While there are a mix of things here, most of the stuff were written from Kernel developer's PoV. So, add them to the driver-api book.
A follow up for this patch would be to move documents from there that are specific to sysadmins, adding them to the admin-guide.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
Greg Kroah-Hartman
maintainerRe: [PATCH v1 14/22] docs: usb: rename files to .rst and add them to drivers-api
In reply to Mauro Carvalho ChehabQuoted 9 lines · Mauro Carvalho Chehab
While there are a mix of things here, most of the stuff were written from Kernel developer's PoV. So, add them to the driver-api book.
A follow up for this patch would be to move documents from there that are specific to sysadmins, adding them to the admin-guide.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
Ah, I guess I can take this through my tree, will do that later today.
thanks,
greg k-h
Re: [PATCH v1 14/22] docs: usb: rename files to .rst and add them to drivers-api
In reply to Mauro Carvalho ChehabQuoted 9 lines · Mauro Carvalho Chehab
While there are a mix of things here, most of the stuff were written from Kernel developer's PoV. So, add them to the driver-api book.
A follow up for this patch would be to move documents from there that are specific to sysadmins, adding them to the admin-guide.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
PATCH 15/22 docs: driver-api: add a chapter for memory-related API
In reply to Mauro Carvalho ChehabThere are some DMA files under the main dir. Move them to the new chapter and add an index file for them.
---
Documentation/PCI/pci.rst | 6 +++---
Documentation/block/biodoc.rst | 2 +-
.../driver-api/bus-virt-phys-mapping.rst | 2 +-
Documentation/driver-api/index.rst | 2 ++
.../mm/dma-api-howto.rst} | 2 --
.../{DMA-API.rst => driver-api/mm/dma-api.rst} | 8 +++-----
.../mm/dma-attributes.rst} | 2 --
.../mm/dma-isa-lpc.rst} | 4 +---
Documentation/driver-api/mm/index.rst | 11 +++++++++++
Documentation/driver-api/usb/dma.rst | 6 +++---
Documentation/memory-barriers.txt | 6 +++---
.../translations/ko_KR/memory-barriers.txt | 6 +++---
arch/ia64/hp/common/sba_iommu.c | 12 ++++++------
arch/ia64/sn/pci/pci_dma.c | 4 ++--
arch/parisc/kernel/pci-dma.c | 2 +-
arch/x86/include/asm/dma-mapping.h | 4 ++--
arch/x86/kernel/amd_gart_64.c | 2 +-
drivers/parisc/sba_iommu.c | 16 ++++++++--------
include/linux/dma-mapping.h | 2 +-
include/media/videobuf-dma-sg.h | 2 +-
kernel/dma/debug.c | 2 +-
21 files changed, 54 insertions(+), 49 deletions(-)
rename Documentation/{DMA-API-HOWTO.rst => driver-api/mm/dma-api-howto.rst} (99%)
rename Documentation/{DMA-API.rst => driver-api/mm/dma-api.rst} (99%)
rename Documentation/{DMA-attributes.rst => driver-api/mm/dma-attributes.rst} (99%)
rename Documentation/{DMA-ISA-LPC.rst => driver-api/mm/dma-isa-lpc.rst} (98%)
create mode 100644 Documentation/driver-api/mm/index.rstDocumentation/PCI/pci.rst +3 -3
@@ -265,7 +265,7 @@ Set the DMA mask size --------------------- .. note:: If anything below doesn't make sense, please refer to - Documentation/DMA-API.rst. This section is just a reminder that + Documentation/driver-api/mm/dma-api.rst. This section is just a reminder that drivers need to indicate DMA capabilities of the device and is not an authoritative source for DMA interfaces.
@@ -291,7 +291,7 @@ Many 64-bit "PCI" devices (before PCI-X) and some PCI-X devices are Setup shared control data ------------------------- Once the DMA masks are set, the driver can allocate "consistent" (a.k.a. shared) -memory. See Documentation/DMA-API.rst for a full description of +memory. See Documentation/driver-api/mm/dma-api.rst for a full description of the DMA APIs. This section is just a reminder that it needs to be done before enabling DMA on the device.
@@ -421,7 +421,7 @@ owners if there is one. Then clean up "consistent" buffers which contain the control data. -See Documentation/DMA-API.rst for details on unmapping interfaces. +See Documentation/driver-api/mm/dma-api.rst for details on unmapping interfaces. Unregister from other subsystems
Documentation/block/biodoc.rst +1 -1
@@ -195,7 +195,7 @@ a virtual address mapping (unlike the earlier scheme of virtual address do not have a corresponding kernel virtual address space mapping) and low-memory pages. -Note: Please refer to Documentation/DMA-API-HOWTO.rst for a discussion +Note: Please refer to Documentation/driver-api/mm/dma-api-howto.rst for a discussion on PCI high mem DMA aspects and mapping of scatter gather lists, and support for 64 bit PCI.
Documentation/driver-api/bus-virt-phys-mapping.rst +1 -1
@@ -8,7 +8,7 @@ How to access I/O mapped memory from within device drivers The virt_to_bus() and bus_to_virt() functions have been superseded by the functionality provided by the PCI DMA interface - (see Documentation/DMA-API-HOWTO.rst). They continue + (see Documentation/driver-api/mm/dma-api-howto.rst). They continue to be documented below for historical purposes, but new code must not use them. --davidm 00/12/12
Documentation/driver-api/index.rst +2 -0
@@ -16,6 +16,7 @@ available subsections can be seen below. basics infrastructure + mm/index pm/index clk device-io
@@ -59,6 +60,7 @@ available subsections can be seen below. fpga/index acpi/index generic-counter + mm/index atomic_bitops bt8xxgpio
Documentation/driver-api/mm/dma-api-howto.rst renamed from Documentation/DMA-API-HOWTO.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ========================= Dynamic DMA mapping Guide =========================
Documentation/driver-api/mm/dma-api.rst renamed from Documentation/DMA-API.rst +3 -5
@@ -1,5 +1,3 @@ -:orphan: - ============================================ Dynamic DMA mapping using the generic device ============================================
@@ -7,7 +5,7 @@ Dynamic DMA mapping using the generic device :Author: James E.J. Bottomley <[email protected]> This document describes the DMA API. For a more gentle introduction -of the API (and actual examples), see Documentation/DMA-API-HOWTO.rst. +of the API (and actual examples), see Documentation/driver-api/mm/dma-api-howto.rst. This API is split into two pieces. Part I describes the basic API. Part II describes extensions for supporting non-consistent memory
@@ -465,7 +463,7 @@ without the _attrs suffixes, except that they pass an optional dma_attrs. The interpretation of DMA attributes is architecture-specific, and -each attribute should be documented in Documentation/DMA-attributes.rst. +each attribute should be documented in Documentation/driver-api/mm/dma-attributes.rst. If dma_attrs are 0, the semantics of each of these functions is identical to those of the corresponding function
@@ -478,7 +476,7 @@ for DMA:: #include <linux/dma-mapping.h> /* DMA_ATTR_FOO should be defined in linux/dma-mapping.h and - * documented in Documentation/DMA-attributes.rst */ + * documented in Documentation/driver-api/mm/dma-attributes.rst */ ... unsigned long attr;
Documentation/driver-api/mm/dma-attributes.rst renamed from Documentation/DMA-attributes.rst +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ============== DMA attributes ==============
Documentation/driver-api/mm/dma-isa-lpc.rst renamed from Documentation/DMA-ISA-LPC.rst +1 -3
@@ -1,5 +1,3 @@ -:orphan: - ============================ DMA with ISA and LPC devices ============================
@@ -19,7 +17,7 @@ To do ISA style DMA you need to include two headers:: #include <asm/dma.h> The first is the generic DMA API used to convert virtual addresses to -bus addresses (see Documentation/DMA-API.rst for details). +bus addresses (see Documentation/driver-api/mm/dma-api.rst for details). The second contains the routines specific to ISA DMA transfers. Since this is not present on all platforms make sure you construct your
Documentation/driver-api/mm/index.rst new file +11 -0
@@ -0,0 +1,11 @@ +========================== +Memory Related Kernel APIs +========================== + +.. toctree:: + :maxdepth: 1 + + dma-api + dma-api-howto + dma-attributes + dma-isa-lpc
Documentation/driver-api/usb/dma.rst +3 -3
@@ -10,7 +10,7 @@ API overview The big picture is that USB drivers can continue to ignore most DMA issues, though they still must provide DMA-ready buffers (see -``Documentation/DMA-API-HOWTO.rst``). That's how they've worked through +``Documentation/driver-api/mm/dma-api-howto.rst``). That's how they've worked through the 2.4 (and earlier) kernels, or they can now be DMA-aware. DMA-aware usb drivers:
@@ -60,7 +60,7 @@ and effects like cache-trashing can impose subtle penalties. force a consistent memory access ordering by using memory barriers. It's not using a streaming DMA mapping, so it's good for small transfers on systems where the I/O would otherwise thrash an IOMMU mapping. (See - ``Documentation/DMA-API-HOWTO.rst`` for definitions of "coherent" and + ``Documentation/driver-api/mm/dma-api-howto.rst`` for definitions of "coherent" and "streaming" DMA mappings.) Asking for 1/Nth of a page (as well as asking for N pages) is reasonably
@@ -91,7 +91,7 @@ Working with existing buffers Existing buffers aren't usable for DMA without first being mapped into the DMA address space of the device. However, most buffers passed to your driver can safely be used with such DMA mapping. (See the first section -of Documentation/DMA-API-HOWTO.rst, titled "What memory is DMA-able?") +of Documentation/driver-api/mm/dma-api-howto.rst, titled "What memory is DMA-able?") - When you're using scatterlists, you can map everything at once. On some systems, this kicks in an IOMMU and turns the scatterlists into single
Documentation/memory-barriers.txt +3 -3
@@ -549,8 +549,8 @@ There are certain things that the Linux kernel memory barriers do not guarantee: [*] For information on bus mastering DMA and coherency please read: Documentation/PCI/pci.rst - Documentation/DMA-API-HOWTO.rst - Documentation/DMA-API.rst + Documentation/driver-api/mm/dma-api-howto.rst + Documentation/driver-api/mm/dma-api.rst DATA DEPENDENCY BARRIERS (HISTORICAL)
@@ -1933,7 +1933,7 @@ There are some more advanced barrier functions: here. See the subsection "Kernel I/O barrier effects" for more information on - relaxed I/O accessors and the Documentation/DMA-API.rst file for more + relaxed I/O accessors and the Documentation/driver-api/mm/dma-api.rst file for more information on consistent memory.
Documentation/translations/ko_KR/memory-barriers.txt +3 -3
@@ -570,8 +570,8 @@ ACQUIRE 는 해당 오퍼레이션의 로드 부분에만 적용되고 RELEASE [*] 버스 마스터링 DMA 와 일관성에 대해서는 다음을 참고하시기 바랍니다: Documentation/PCI/pci.rst - Documentation/DMA-API-HOWTO.rst - Documentation/DMA-API.rst + Documentation/driver-api/mm/dma-api-howto.rst + Documentation/driver-api/mm/dma-api.rst 데이터 의존성 배리어 (역사적)
@@ -1904,7 +1904,7 @@ Mandatory 배리어들은 SMP 시스템에서도 UP 시스템에서도 SMP 효 writel_relaxed() 와 같은 완화된 I/O 접근자들에 대한 자세한 내용을 위해서는 "커널 I/O 배리어의 효과" 섹션을, consistent memory 에 대한 자세한 내용을 - 위해선 Documentation/DMA-API.rst 문서를 참고하세요. + 위해선 Documentation/driver-api/mm/dma-api.rst 문서를 참고하세요. MMIO 쓰기 배리어
arch/ia64/hp/common/sba_iommu.c +6 -6
@@ -912,7 +912,7 @@ sba_mark_invalid(struct ioc *ioc, dma_addr_t iova, size_t byte_cnt)* @dir: dma direction * @attrs: optional dma attributes * -* See Documentation/DMA-API-HOWTO.rst +* See Documentation/driver-api/mm/dma-api-howto.rst */ static dma_addr_t sba_map_page(struct device *dev, struct page *page, unsigned long poff, size_t size,
@@ -1033,7 +1033,7 @@ sba_mark_clean(struct ioc *ioc, dma_addr_t iova, size_t size)* @dir: R/W or both. * @attrs: optional dma attributes * -* See Documentation/DMA-API-HOWTO.rst +* See Documentation/driver-api/mm/dma-api-howto.rst */ static void sba_unmap_page (struct device *dev,dma_addr_t iova,size_t size,enum dma_data_direction dir,unsigned long attrs)
@@ -1110,7 +1110,7 @@ static void sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size,* @size: number of bytes mapped in driver buffer. * @dma_handle: IOVA of new buffer. * -* See Documentation/DMA-API-HOWTO.rst +* See Documentation/driver-api/mm/dma-api-howto.rst */ static void * sba_alloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle,
@@ -1167,7 +1167,7 @@ sba_alloc_coherent(struct device *dev, size_t size, dma_addr_t *dma_handle,* @vaddr: virtual address IOVA of "consistent" buffer. * @dma_handler: IO virtual address of "consistent" buffer. * -* See Documentation/DMA-API-HOWTO.rst +* See Documentation/driver-api/mm/dma-api-howto.rst */ static void sba_free_coherent (struct device *dev,size_t size,void *vaddr,dma_addr_t dma_handle,unsigned long attrs)
@@ -1430,7 +1430,7 @@ static void sba_unmap_sg_attrs(struct device *dev, struct scatterlist *sglist,* @dir: R/W or both. * @attrs: optional dma attributes * -* See Documentation/DMA-API-HOWTO.rst +* See Documentation/driver-api/mm/dma-api-howto.rst */ static int sba_map_sg_attrs(struct device *dev, struct scatterlist *sglist, int nents, enum dma_data_direction dir,
@@ -1529,7 +1529,7 @@ static int sba_map_sg_attrs(struct device *dev, struct scatterlist *sglist,* @dir: R/W or both. * @attrs: optional dma attributes * -* See Documentation/DMA-API-HOWTO.rst +* See Documentation/driver-api/mm/dma-api-howto.rst */ static void sba_unmap_sg_attrs(struct device *dev, struct scatterlist *sglist, int nents, enum dma_data_direction dir,
arch/ia64/sn/pci/pci_dma.c +2 -2
@@ -5,7 +5,7 @@* * Copyright (C) 2000,2002-2005 Silicon Graphics, Inc. All rights reserved. * -* Routines for PCI DMA mapping. See Documentation/DMA-API.rst for +* Routines for PCI DMA mapping. See Documentation/driver-api/mm/dma-api.rst for * a description of how these routines should be used. */
@@ -72,7 +72,7 @@ EXPORT_SYMBOL(sn_dma_set_mask);* that @dma_handle will have the %PCIIO_DMA_CMD flag set. * * This interface is usually used for "command" streams (e.g. the command -* queue for a SCSI controller). See Documentation/DMA-API.rst for +* queue for a SCSI controller). See Documentation/driver-api/mm/dma-api.rst for * more information. */ static void *sn_dma_alloc_coherent(struct device *dev, size_t size,
arch/parisc/kernel/pci-dma.c +1 -1
@@ -3,7 +3,7 @@ ** PARISC 1.1 Dynamic DMA mapping support. ** This implementation is for PA-RISC platforms that do not support ** I/O TLBs (aka DMA address translation hardware). -** See Documentation/DMA-API-HOWTO.rst for interface definitions. +** See Documentation/driver-api/mm/dma-api-howto.rst for interface definitions. ** ** (c) Copyright 1999,2000 Hewlett-Packard Company ** (c) Copyright 2000 Grant Grundler
arch/x86/include/asm/dma-mapping.h +2 -2
@@ -3,8 +3,8 @@#define _ASM_X86_DMA_MAPPING_H/* -* IOMMU interface. See Documentation/DMA-API-HOWTO.rst and -* Documentation/DMA-API.rst for documentation. +* IOMMU interface. See Documentation/driver-api/mm/dma-api-howto.rst and +* Documentation/driver-api/mm/dma-api.rst for documentation. */ #include <linux/scatterlist.h>
arch/x86/kernel/amd_gart_64.c +1 -1
@@ -6,7 +6,7 @@* This allows to use PCI devices that only support 32bit addresses on systems * with more than 4GB. * -* See Documentation/DMA-API-HOWTO.rst for the interface specification. +* See Documentation/driver-api/mm/dma-api-howto.rst for the interface specification. * * Copyright 2002 Andi Kleen, SuSE Labs. */
drivers/parisc/sba_iommu.c +8 -8
@@ -666,7 +666,7 @@ sba_mark_invalid(struct ioc *ioc, dma_addr_t iova, size_t byte_cnt)* @dev: instance of PCI owned by the driver that's asking * @mask: number of address bits this PCI device can handle * -* See Documentation/DMA-API-HOWTO.rst +* See Documentation/driver-api/mm/dma-api-howto.rst */ static int sba_dma_supported (struct device *dev,u64 mask) {
@@ -678,7 +678,7 @@ static int sba_dma_supported( struct device *dev, u64 mask)return (0 ); } -/* Documentation/DMA-API-HOWTO.rst tells drivers to try 64-bit +/* Documentation/driver-api/mm/dma-api-howto.rst tells drivers to try 64-bit * first, then fall back to 32-bit if that fails. * We are just "encouraging" 32-bit DMA masks here since we can * never allow IOMMU bypass unless we add special support for ZX1.
@@ -706,7 +706,7 @@ static int sba_dma_supported( struct device *dev, u64 mask)* @size: number of bytes to map in driver buffer. * @direction: R/W or both. * -* See Documentation/DMA-API-HOWTO.rst +* See Documentation/driver-api/mm/dma-api-howto.rst */ static dma_addr_t sba_map_single(struct device *dev, void *addr, size_t size,
@@ -796,7 +796,7 @@ sba_map_page(struct device *dev, struct page *page, unsigned long offset,* @size: number of bytes mapped in driver buffer. * @direction: R/W or both. * -* See Documentation/DMA-API-HOWTO.rst +* See Documentation/driver-api/mm/dma-api-howto.rst */ static void sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size,
@@ -875,7 +875,7 @@ sba_unmap_page(struct device *dev, dma_addr_t iova, size_t size,* @size: number of bytes mapped in driver buffer. * @dma_handle: IOVA of new buffer. * -* See Documentation/DMA-API-HOWTO.rst +* See Documentation/driver-api/mm/dma-api-howto.rst */ static void *sba_alloc (struct device *hwdev,size_t size,dma_addr_t *dma_handle,gfp_t gfp,unsigned long attrs)
@@ -906,7 +906,7 @@ static void *sba_alloc(struct device *hwdev, size_t size, dma_addr_t *dma_handle* @vaddr: virtual address IOVA of "consistent" buffer. * @dma_handler: IO virtual address of "consistent" buffer. * -* See Documentation/DMA-API-HOWTO.rst +* See Documentation/driver-api/mm/dma-api-howto.rst */ static void sba_free(struct device *hwdev, size_t size, void *vaddr,
@@ -941,7 +941,7 @@ int dump_run_sg = 0;* @nents: number of entries in list * @direction: R/W or both. * -* See Documentation/DMA-API-HOWTO.rst +* See Documentation/driver-api/mm/dma-api-howto.rst */ static int sba_map_sg(struct device *dev, struct scatterlist *sglist, int nents,
@@ -1025,7 +1025,7 @@ sba_map_sg(struct device *dev, struct scatterlist *sglist, int nents,* @nents: number of entries in list * @direction: R/W or both. * -* See Documentation/DMA-API-HOWTO.rst +* See Documentation/driver-api/mm/dma-api-howto.rst */ static void sba_unmap_sg(struct device *dev, struct scatterlist *sglist, int nents,
include/linux/dma-mapping.h +1 -1
@@ -14,7 +14,7 @@/** * List of possible attributes associated with a DMA mapping. The semantics -* of each attribute should be defined in Documentation/DMA-attributes.rst. +* of each attribute should be defined in Documentation/driver-api/mm/dma-attributes.rst. * * DMA_ATTR_WRITE_BARRIER: DMA to a memory region with this attribute * forces all pending DMA writes to complete.
include/media/videobuf-dma-sg.h +1 -1
@@ -34,7 +34,7 @@* does memory allocation too using vmalloc_32(). * * videobuf_dma_*() -* see Documentation/DMA-API-HOWTO.rst, these functions to +* see Documentation/driver-api/mm/dma-api-howto.rst, these functions to * basically the same. The map function does also build a * scatterlist for the buffer (and unmap frees it ...) *
kernel/dma/debug.c +1 -1
@@ -1069,7 +1069,7 @@ static void check_unmap(struct dma_debug_entry *ref)/* * Drivers should use dma_mapping_error() to check the returned * addresses of dma_map_single() and dma_map_page(). -* If not, print this warning message. See Documentation/DMA-API.rst. +* If not, print this warning message. See Documentation/driver-api/mm/dma-api.rst. */ if (entry->map_err_type ==MAP_ERR_NOT_CHECKED ) { err_printk(ref->dev, entry,
Signature · 6 lines
2.21.0 _______________________________________________ iommu mailing list [email protected] https://lists.linuxfoundation.org/mailman/listinfo/iommu
PATCH 16/22 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
@@ -124,6 +124,7 @@ available subsections can be seen below. unaligned-memory-access vfio vfio-mediated-device + xilinx/index xillybus xz 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 · 7 lines
2.21.0 _______________________________________________ linux-arm-kernel mailing list [email protected] http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
PATCH 17/22 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/riscv/index.rst | 2 -- Documentation/s390/index.rst | 2 -- Documentation/sparc/index.rst | 2 -- Documentation/xtensa/index.rst | 2 -- 9 files changed, 10 insertions(+), 16 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
@@ -116,7 +116,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 +0 -2
@@ -1,5 +1,3 @@ -:orphan: - ================= m68k Architecture =================
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 +0 -2
@@ -1,5 +1,3 @@ -:orphan: - =================== Xtensa Architecture ===================
Signature · 1 line
2.21.0
PATCH 18/22 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
@@ -3159,7 +3159,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/driver-api/debugging-via-ohci1394.rst 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
@@ -2276,7 +2276,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 19/22 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/index.rst | 3 +++ Documentation/mic/index.rst | 2 -- Documentation/phy/samsung-usb2.rst | 2 -- Documentation/scheduler/index.rst | 2 -- 4 files changed, 3 insertions(+), 6 deletions(-)
Documentation/index.rst +3 -0
@@ -105,6 +105,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 20/22 docs: extcon: move it to acpi dir and convert it to ReST
In reply to Mauro Carvalho ChehabThe intel-int3496.txt file is a documentation for an ACPI driver.
There's no reason to keep it on a separate directory.
So, instead of keeping it on some random location, move it to a sub-directory inside the ACPI documentation dir.
For now, keep it with .txt extension, in order to avoid Sphinx build noise. A later patch should change it to .rst and movin it to be together with other acpi docs.
---
.../acpi/extcon-intel-int3496.rst} | 14 ++++++++++----
Documentation/firmware-guide/acpi/index.rst | 1 +
MAINTAINERS | 6 +++---
3 files changed, 14 insertions(+), 7 deletions(-)
rename Documentation/{extcon/intel-int3496.txt => firmware-guide/acpi/extcon-intel-int3496.rst} (66%)Documentation/firmware-guide/acpi/extcon-intel-int3496.rst renamed from Documentation/extcon/intel-int3496.txt +10 -4
@@ -1,5 +1,6 @@ +===================================================== Intel INT3496 ACPI device extcon driver documentation ------------------------------------------------------ +===================================================== The Intel INT3496 ACPI device extcon driver is a driver for ACPI devices with an acpi-id of INT3496, such as found for example on
@@ -13,15 +14,20 @@ between an USB host and an USB peripheral controller. The ACPI devices exposes this functionality by returning an array with up to 3 gpio descriptors from its ACPI _CRS (Current Resource Settings) call: -Index 0: The input gpio for the id-pin, this is always present and valid -Index 1: The output gpio for enabling Vbus output from the device to the otg +======= ===================================================================== +Index 0 The input gpio for the id-pin, this is always present and valid +Index 1 The output gpio for enabling Vbus output from the device to the otg port, write 1 to enable the Vbus output (this gpio descriptor may be absent or invalid) -Index 2: The output gpio for muxing of the data pins between the USB host and +Index 2 The output gpio for muxing of the data pins between the USB host and the USB peripheral controller, write 1 to mux to the peripheral controller +======= ===================================================================== There is a mapping between indices and GPIO connection IDs as follows + + ======= ======= id index 0 vbus index 1 mux index 2 + ======= =======
Documentation/firmware-guide/acpi/index.rst +1 -0
@@ -24,3 +24,4 @@ ACPI Support acpi-lid lpit video_extension + extcon-intel-int3496
MAINTAINERS +3 -3
@@ -321,7 +321,7 @@ F: drivers/pnp/pnpacpi/ F: include/linux/acpi.h F: include/linux/fwnode.h F: include/acpi/ -F: Documentation/acpi/ +F: Documentation/firmware-guide/acpi/ F: Documentation/ABI/testing/sysfs-bus-acpi F: Documentation/ABI/testing/configfs-acpi F: drivers/pci/*acpi*
@@ -4881,7 +4881,7 @@ S: Maintained F: Documentation/ F: scripts/kernel-doc X: Documentation/ABI/ -X: Documentation/acpi/ +X: Documentation/firmware-guide/acpi/ X: Documentation/devicetree/ X: Documentation/i2c/ X: Documentation/media/
@@ -6057,7 +6057,7 @@ S: Maintained F: drivers/extcon/ F: include/linux/extcon/ F: include/linux/extcon.h -F: Documentation/extcon/ +F: Documentation/firmware-guide/acpi/extcon-intel-int3496.rst F: Documentation/devicetree/bindings/extcon/ EXYNOS DP DRIVER
Signature · 1 line
2.21.0
Re: [PATCH v1 20/22] docs: extcon: move it to acpi dir and convert it to ReST
Quoted 4 lines · CEST Mauro Carvalho Chehab
The intel-int3496.txt file is a documentation for an ACPI driver.
There's no reason to keep it on a separate directory.
Quoted 8 lines
So, instead of keeping it on some random location, move it to a sub-directory inside the ACPI documentation dir.
For now, keep it with .txt extension, in order to avoid Sphinx build noise. A later patch should change it to .rst and movin it to be together with other acpi docs.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
Or please let me know if you want me to pick up this one.
Quoted 87 lines
--- .../acpi/extcon-intel-int3496.rst} | 14 ++++++++++---- Documentation/firmware-guide/acpi/index.rst | 1 + MAINTAINERS | 6 +++--- 3 files changed, 14 insertions(+), 7 deletions(-) rename Documentation/{extcon/intel-int3496.txt => firmware-guide/acpi/extcon-intel-int3496.rst} (66%)Documentation/firmware-guide/acpi/extcon-intel-int3496.rst renamed from Documentation/extcon/intel-int3496.txt +10
-4@@ -1,5 +1,6 @@ +===================================================== Intel INT3496 ACPI device extcon driver documentation ------------------------------------------------------ +===================================================== The Intel INT3496 ACPI device extcon driver is a driver for ACPI devices with an acpi-id of INT3496, such as found for example on@@ -13,15 +14,20 @@ between an USB host and an USB peripheral controller. The ACPI devices exposes this functionality by returning an array with up to 3 gpio descriptors from its ACPI _CRS (Current Resource Settings) call: -Index 0: The input gpio for the id-pin, this is always present and valid -Index 1: The output gpio for enabling Vbus output from the device to the otg +======= ===================================================================== +Index 0 The input gpio for the id-pin, this is always present and valid +Index 1 The output gpio for enabling Vbus output from the device to the otg port, write 1 to enable the Vbus output (this gpio descriptor may be absent or invalid) -Index 2: The output gpio for muxing of the data pins between the USB host and +Index 2 The output gpio for muxing of the data pins between the USB host and the USB peripheral controller, write 1 to mux to the peripheral controller +======= ===================================================================== There is a mapping between indices and GPIO connection IDs as follows + + ======= ======= id index 0 vbus index 1 mux index 2 + ======= =======Documentation/firmware-guide/acpi/index.rst +1
-0@@ -24,3 +24,4 @@ ACPI Support acpi-lid lpit video_extension + extcon-intel-int3496MAINTAINERS +3
-3@@ -321,7 +321,7 @@ F: drivers/pnp/pnpacpi/ F: include/linux/acpi.h F: include/linux/fwnode.h F: include/acpi/ -F: Documentation/acpi/ +F: Documentation/firmware-guide/acpi/ F: Documentation/ABI/testing/sysfs-bus-acpi F: Documentation/ABI/testing/configfs-acpi F: drivers/pci/*acpi*@@ -4881,7 +4881,7 @@ S: Maintained F: Documentation/ F: scripts/kernel-doc X: Documentation/ABI/ -X: Documentation/acpi/ +X: Documentation/firmware-guide/acpi/ X: Documentation/devicetree/ X: Documentation/i2c/ X: Documentation/media/@@ -6057,7 +6057,7 @@ S: Maintained F: drivers/extcon/ F: include/linux/extcon/ F: include/linux/extcon.h -F: Documentation/extcon/ +F: Documentation/firmware-guide/acpi/extcon-intel-int3496.rst F: Documentation/devicetree/bindings/extcon/ EXYNOS DP DRIVER
Rafael J. Wysocki
maintainerRe: [PATCH v1 20/22] docs: extcon: move it to acpi dir and convert it to ReST
Quoted 9 lines · Rafael J. Wysocki
Quoted 7 lines · CEST Mauro Carvalho Chehab
The intel-int3496.txt file is a documentation for an ACPI driver.
There's no reason to keep it on a separate directory.
So, instead of keeping it on some random location, move it to a sub-directory inside the ACPI documentation dir.
Quoted 7 lines
Quoted 5 lines
For now, keep it with .txt extension, in order to avoid Sphinx build noise. A later patch should change it to .rst and movin it to be together with other acpi docs.
Signed-off-by Mauro Carvalho Chehab <[email protected]>
Which said, the changelog appears to be outdated, because the format of the doc *does* change.
Quoted 8 lines
Quoted 8 lines
--- .../acpi/extcon-intel-int3496.rst} | 14 ++++++++++---- Documentation/firmware-guide/acpi/index.rst | 1 + MAINTAINERS | 6 +++--- 3 files changed, 14 insertions(+), 7 deletions(-) rename Documentation/{extcon/intel-int3496.txt => firmware-guide/acpi/extcon-intel-int3496.rst} (66%)Documentation/firmware-guide/acpi/extcon-intel-int3496.rst renamed from Documentation/extcon/intel-int3496.txt +0
-0
Re: [PATCH v1 20/22] docs: extcon: move it to acpi dir and convert it to ReST
In reply to Rafael J. WysockiEm Wed, 19 Jun 2019 11:59:18 +0200
"Rafael J. Wysocki" <[email protected]> escreveu:
Quoted 12 lines · CEST Mauro Carvalho Chehab
Quoted 11 lines
The intel-int3496.txt file is a documentation for an ACPI driver.
There's no reason to keep it on a separate directory.
So, instead of keeping it on some random location, move it to a sub-directory inside the ACPI documentation dir.
For now, keep it with .txt extension, in order to avoid Sphinx build noise. A later patch should change it to .rst and movin it to be together with other acpi docs.
Quoted 5 lines
Quoted 1 line
Signed-off-by Mauro Carvalho Chehab <[email protected]>Or please let me know if you want me to pick up this one.
Feel free to pick it.
Thanks,
Mauro
PATCH 21/22 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
@@ -79,6 +79,7 @@ configure specific aspects of kernel behavior to your liking. aoe/index perf-security acpi/index + laptops/index btmrvl clearing-warn-once
Documentation/admin-guide/kernel-parameters.txt +1 -1
@@ -4356,7 +4356,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
@@ -8927,7 +8927,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
@@ -14756,7 +14756,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
@@ -451,7 +451,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"
@@ -503,7 +503,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
Re: [PATCH v1 21/22] docs: admin-guide: add laptops documentation
Quoted 4 lines · Mauro Carvalho Chehab
The docs under
Documentation/laptopscontain users specific information.
with a caveat about Documentation/admin-guide/sysctl/vm.rst. How block bump is related to laptops? It sounds rather common debugging feature, no?
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@@ -79,6 +79,7 @@ configure specific aspects of kernel behavior to your liking. aoe/index perf-security acpi/index + laptops/index btmrvl clearing-warn-onceDocumentation/admin-guide/kernel-parameters.txt +1
-1@@ -4356,7 +4356,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@@ -8927,7 +8927,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@@ -14756,7 +14756,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@@ -451,7 +451,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"@@ -503,7 +503,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
PATCH 22/22 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 This is the beginning of a section with information of interest to application developers. Documents covering various aspects of the kernel
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
@@ -8571,7 +8571,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
@@ -2009,7 +2009,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
@@ -995,7 +995,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
@@ -624,7 +624,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
@@ -2052,7 +2052,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"
@@ -2089,7 +2089,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