blob: ee4cc72735b7a5d09d88f2c504799d2a68120a0f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001
2This is a brief list of all the files in ./linux/Documentation and what
3they contain. If you add a documentation file, please list it here in
4alphabetical order as well, or risk being hunted down like a rabid dog.
Paul Gortmaker449e3a72013-02-14 15:20:54 -05005Please keep the descriptions small enough to fit on one line.
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 Thanks -- Paul G.
7
8Following translations are available on the WWW:
9
Masanari Iida010f4562012-02-14 23:19:07 +090010 - Japanese, maintained by the JF Project (jf@listserv.linux.or.jp), at
11 http://linuxjf.sourceforge.jp/
Linus Torvalds1da177e2005-04-16 15:20:36 -070012
1300-INDEX
14 - this file.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070015ABI/
16 - info on kernel <-> userspace ABI and relative interface stability.
Len Brownb4d27302007-11-14 19:53:21 -050017
Linus Torvalds1da177e2005-04-16 15:20:36 -070018BUG-HUNTING
19 - brute force method of doing binary search of patches to find bug.
20Changes
21 - list of changes that break older software packages.
22CodingStyle
Paul Gortmaker449e3a72013-02-14 15:20:54 -050023 - how the maintainers expect the C code in the kernel to look.
Linus Torvalds1da177e2005-04-16 15:20:36 -070024DMA-API.txt
25 - DMA API, pci_ API & extensions for non-consistent memory machines.
Paul Gortmaker449e3a72013-02-14 15:20:54 -050026DMA-API-HOWTO.txt
27 - Dynamic DMA mapping Guide
Rob Landley5ef43562007-10-16 23:31:25 -070028DMA-ISA-LPC.txt
29 - How to do DMA with ISA (and LPC) devices.
Paul Gortmaker449e3a72013-02-14 15:20:54 -050030DMA-attributes.txt
31 - listing of the various possible attributes a DMA region can have
Linus Torvalds1da177e2005-04-16 15:20:36 -070032DocBook/
33 - directory with DocBook templates etc. for kernel documentation.
Paul Gortmaker449e3a72013-02-14 15:20:54 -050034EDID/
35 - directory with info on customizing EDID for broken gfx/displays.
Greg Kroah-Hartmand36cc9d2005-11-18 09:31:11 -080036HOWTO
Jesper Juhlf6b07d32007-07-15 23:41:41 -070037 - the process and procedures of how to do Linux kernel development.
Linus Torvalds1da177e2005-04-16 15:20:36 -070038IPMI.txt
39 - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
40IRQ-affinity.txt
41 - how to select which CPU(s) handle which interrupt events on SMP.
Paul Gortmaker449e3a72013-02-14 15:20:54 -050042IRQ-domain.txt
Murilo Opsfelder Araujo453f42d2013-08-20 20:48:39 -030043 - info on interrupt numbering and setting up IRQ domains.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070044IRQ.txt
45 - description of what an IRQ is.
Paul Gortmaker449e3a72013-02-14 15:20:54 -050046Intel-IOMMU.txt
47 - basic info on the Intel IOMMU virtualization support.
48Makefile
Shuah Khanf59c6682016-10-06 16:12:29 -060049 - This file does nothing. Removing it breaks make htmldocs and
50 make distclean.
Linus Torvalds1da177e2005-04-16 15:20:36 -070051ManagementStyle
52 - how to (attempt to) manage kernel hackers.
Linus Torvalds1da177e2005-04-16 15:20:36 -070053RCU/
54 - directory with info on RCU (read-copy update).
Linus Torvalds1da177e2005-04-16 15:20:36 -070055SAK.txt
56 - info on Secure Attention Keys.
Rob Landley5ef43562007-10-16 23:31:25 -070057SM501.txt
58 - Silicon Motion SM501 multimedia companion chip
Jesper Juhlf6b07d32007-07-15 23:41:41 -070059SecurityBugs
60 - procedure for reporting security bugs found in the kernel.
61SubmitChecklist
62 - Linux kernel patch submission checklist.
Linus Torvalds1da177e2005-04-16 15:20:36 -070063SubmittingDrivers
64 - procedure to get a new driver source included into the kernel tree.
65SubmittingPatches
66 - procedure to get a source patch included into the kernel tree.
67VGA-softcursor.txt
68 - how to change your VGA cursor from a blinking underscore.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070069accounting/
70 - documentation on accounting and taskstats.
Len Brownb4d27302007-11-14 19:53:21 -050071acpi/
72 - info on ACPI-specific hooks in the kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070073aoe/
74 - description of AoE (ATA over Ethernet) along with config examples.
Jesper Juhl754c7972005-09-09 13:10:12 -070075applying-patches.txt
76 - description of various trees and how to apply their patches.
Linus Torvalds1da177e2005-04-16 15:20:36 -070077arm/
78 - directory with info about Linux on the ARM architecture.
Paul Gortmaker449e3a72013-02-14 15:20:54 -050079arm64/
80 - directory with info about Linux on the 64 bit ARM architecture.
Henrik Austad3cf8ca12014-02-10 14:25:33 -080081assoc_array.txt
82 - generic associative array intro.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070083atomic_ops.txt
84 - semantics and behavior of atomic and bitmask operations.
85auxdisplay/
86 - misc. LCD driver documentation (cfag12864b, ks0108).
Paul Gortmaker449e3a72013-02-14 15:20:54 -050087backlight/
88 - directory with info on controlling backlights in flat panel displays
89bad_memory.txt
90 - how to use kernel parameters to exclude bad RAM regions.
Linus Torvalds1da177e2005-04-16 15:20:36 -070091basic_profiling.txt
92 - basic instructions for those who wants to profile Linux kernel.
Henrik Austad3cf8ca12014-02-10 14:25:33 -080093bcache.txt
94 - Block-layer cache on fast SSDs to improve slow (raid) I/O performance.
Linus Torvalds1da177e2005-04-16 15:20:36 -070095binfmt_misc.txt
96 - info on the kernel support for extra binary formats.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070097blackfin/
98 - directory with documentation for the Blackfin arch.
Linus Torvalds1da177e2005-04-16 15:20:36 -070099block/
100 - info on the Block I/O (BIO) layer.
Randy Dunlap31c00fc2008-11-13 21:33:24 +0000101blockdev/
102 - info on block devices & drivers
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500103braille-console.txt
104 - info on how to use serial devices for Braille support.
105bt8xxgpio.txt
106 - info on how to modify a bt8xx video card for GPIO usage.
Bing Zhao196be0c2009-06-02 14:29:38 -0700107btmrvl.txt
108 - info on Marvell Bluetooth driver usage.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500109bus-devices/
110 - directory with info on TI GPMC (General Purpose Memory Controller)
Randy Dunlap9fe41e42010-07-19 22:20:27 +0000111bus-virt-phys-mapping.txt
112 - how to access I/O mapped memory from within device drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113cachetlb.txt
114 - describes the cache/TLB flushing interfaces Linux uses.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115cdrom/
116 - directory with information on the CD-ROM drivers that Linux has.
Thadeu Lima de Souza Cascardo21acb9c2009-02-04 10:12:08 +0100117cgroups/
118 - cgroups features, including cpusets and memory controller.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500119circular-buffers.txt
120 - how to make use of the existing circular buffer infrastructure
121clk.txt
122 - info on the common clock framework
123coccinelle.txt
124 - info on how to get and use the Coccinelle code checking tool.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700125connector/
126 - docs on the netlink based userspace<->kernel space communication mod.
127console/
128 - documentation on Linux console drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129cpu-freq/
130 - info on CPU frequency and voltage scaling.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700131cpu-hotplug.txt
132 - document describing CPU hotplug support in the Linux kernel.
133cpu-load.txt
134 - document describing how CPU load statistics are collected.
Venkatesh Pallipadife8e2882008-02-14 00:16:13 -0500135cpuidle/
136 - info on CPU_IDLE, CPU idle state management subsystem.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700137cputopology.txt
138 - documentation on how CPU topology info is exported via sysfs.
Bob Pearsonfbedceb2012-03-23 15:02:22 -0700139crc32.txt
140 - brief tutorial on CRC computation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141cris/
142 - directory with info about Linux on CRIS architecture.
143crypto/
144 - directory with info on the Crypto API.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700145dcdbas.txt
146 - information on the Dell Systems Management Base Driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147debugging-modules.txt
148 - some notes on debugging modules after Linux 2.6.3.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500149debugging-via-ohci1394.txt
150 - how to use firewire like a hardware debugger memory reader.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700151dell_rbu.txt
152 - document demonstrating the use of the Dell Remote BIOS Update driver.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500153development-process/
154 - how to work with the mainline kernel development process.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155device-mapper/
156 - directory with info on Device Mapper.
157devices.txt
158 - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500159devicetree/
160 - directory with info on device tree files used by OF/PowerPC/ARM
161digsig.txt
162 -info on the Digital Signature Verification API
163dma-buf-sharing.txt
164 - the DMA Buffer Sharing API Guide
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700165dontdiff
166 - file containing a list of files that should never be diff'ed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167driver-model/
168 - directory with info about Linux driver model.
169dvb/
170 - info on Linux Digital Video Broadcast (DVB) subsystem.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500171dynamic-debug-howto.txt
172 - how to use the dynamic debug (dyndbg) feature.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173early-userspace/
174 - info about initramfs, klibc, and userspace early during boot.
Adrian Bunk4a6b88c2008-02-07 00:13:33 -0800175edac.txt
176 - information on EDAC - Error Detection And Correction
Henrik Austad3cf8ca12014-02-10 14:25:33 -0800177efi-stub.txt
178 - How to use the EFI boot stub to bypass GRUB or elilo on EFI systems.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179eisa.txt
180 - info on EISA bus support.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500181email-clients.txt
182 - info on how to use e-mail to send un-mangled (git) patches.
183extcon/
184 - directory with porting guide for Android kernel switch driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700185fault-injection/
186 - dir with docs about the fault injection capabilities infrastructure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187fb/
188 - directory with info on the frame buffer graphics abstraction layer.
189filesystems/
J. Bruce Fields4f3b19c2007-09-24 18:52:09 -0400190 - info on the vfs and the various filesystems that Linux supports.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191firmware_class/
192 - request_firmware() hotplug interface info.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500193flexible-arrays.txt
194 - how to make use of flexible sized arrays in linux
Alessandro Rubini022c6742013-06-18 23:47:24 +0200195fmc/
196 - information about the FMC bus abstraction
Adrian Bunk0868ff72008-02-03 15:54:28 +0200197frv/
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700198 - Fujitsu FR-V Linux documentation.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500199futex-requeue-pi.txt
200 - info on requeueing of tasks from a non-PI futex to a PI futex
201gcov.txt
202 - use of GCC's coverage testing tool "gcov" with the Linux kernel
Henrik Austad3cf8ca12014-02-10 14:25:33 -0800203gpio/
204 - gpio related documentation
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500205hid/
206 - directory with information on human interface devices
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207highuid.txt
208 - notes on the change from 16 bit to 32 bit user/group IDs.
Henrik Austad8ea8f3e2014-12-26 09:26:22 +0100209hsi.txt
210 - HSI subsystem overview.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500211hwspinlock.txt
212 - hardware spinlock provides hardware assistance for synchronization
Thomas Gleixner3833eec2008-03-05 18:28:15 +0100213timers/
214 - info on the timer related topics
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215hw_random.txt
216 - info on Linux support for random number generator in i8xx chipsets.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700217hwmon/
218 - directory with docs on various hardware monitoring drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219i2c/
220 - directory with info about the I2C bus/protocol (2 wire, kHz speed).
221i2o/
222 - directory with info about the Linux I2O subsystem.
Uwe Hermann71cced62008-10-20 09:32:21 -0700223x86/i386/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 - directory with info about Linux on Intel 32 bit architecture.
225ia64/
226 - directory with info about Linux on Intel 64 bit architecture.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700227infiniband/
228 - directory with documents concerning Linux InfiniBand support.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500229init.txt
230 - what to do when the kernel can't find the 1st process to run.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231initrd.txt
232 - how to use the RAM disk as an initial/temporary root filesystem.
233input/
234 - info on Linux input device support.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500235intel_txt.txt
236 - info on intel Trusted Execution Technology (intel TXT).
Randy Dunlap9fe41e42010-07-19 22:20:27 +0000237io-mapping.txt
238 - description of io_mapping functions in linux/io-mapping.h
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239io_ordering.txt
240 - info on ordering I/O writes to memory-mapped addresses.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700241ioctl/
242 - directory with documents describing various IOCTL calls.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243iostats.txt
244 - info on I/O statistics Linux kernel provides.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700245irqflags-tracing.txt
246 - how to use the irq-flags tracing feature.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247isapnp.txt
248 - info on Linux ISA Plug & Play support.
249isdn/
250 - directory with info on the Linux ISDN support, and supported cards.
251java.txt
252 - info on the in-kernel binary support for Java(tm).
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500253ja_JP/
254 - directory with Japanese translations of various documents
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255kbuild/
256 - directory with info about the kernel build process.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700257kdump/
258 - directory with mini HowTo on getting the crash dump code to work.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259kernel-docs.txt
260 - listing of various WWW + books that document kernel internals.
Jonathan Corbet8ed292f2016-07-20 16:43:41 -0600261kernel-documentation.rst
262 - how to write and format reStructuredText kernel documentation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263kernel-parameters.txt
264 - summary listing of command line / boot prompt args for the kernel.
Henrik Austad3cf8ca12014-02-10 14:25:33 -0800265kernel-per-CPU-kthreads.txt
266 - List of all per-CPU kthreads and how they introduce jitter.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500267kmemcheck.txt
268 - info on dynamic checker that detects uses of uninitialized memory.
269kmemleak.txt
270 - info on how to make use of the kernel memory leak detection system
271ko_KR/
272 - directory with Korean translations of various documents
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273kobject.txt
274 - info of the kobject infrastructure of the Linux kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700275kprobes.txt
276 - documents the kernel probes debugging feature.
277kref.txt
278 - docs on adding reference counters (krefs) to kernel objects.
Henrik Austad8ea8f3e2014-12-26 09:26:22 +0100279kselftest.txt
280 - small unittests for (some) individual codepaths in the kernel.
Carlos Corbachod6ff3652008-02-09 01:32:03 +0000281laptops/
282 - directory with laptop related info and laptop driver documentation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283ldm.txt
284 - a brief description of LDM (Windows Dynamic Disks).
Antonio Ospite9a684e12011-04-04 15:08:46 -0700285leds/
286 - directory with info about LED handling under Linux.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700287local_ops.txt
288 - semantics and behavior of local atomic operations.
Davidlohr Bueso214e0ae2014-07-30 13:41:55 -0700289locking/
290 - directory with info about kernel locking primitives
Jean Delvarefd058732012-10-21 12:05:51 +0200291lockup-watchdogs.txt
292 - info on soft and hard lockup detectors (aka nmi_watchdog).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293logo.gif
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700294 - full colour GIF image of Linux logo (penguin - Tux).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295logo.txt
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700296 - info on creator of above logo & site to get additional images from.
Henrik Austad8ea8f3e2014-12-26 09:26:22 +0100297lzo.txt
298 - kernel LZO decompressor input formats
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299m68k/
300 - directory with info about Linux on Motorola 68k architecture.
301magic-number.txt
302 - list of magic numbers used to mark/protect kernel data structures.
Henrik Austad8ea8f3e2014-12-26 09:26:22 +0100303mailbox.txt
304 - How to write drivers for the common mailbox framework (IPC).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305md.txt
306 - info on boot arguments for the multiple devices driver.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500307media-framework.txt
308 - info on media framework, its data structures, functions and usage.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700309memory-barriers.txt
310 - info on Linux kernel memory barriers.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500311memory-devices/
312 - directory with info on parts like the Texas Instruments EMIF driver
Rob Landley5ef43562007-10-16 23:31:25 -0700313memory-hotplug.txt
314 - Hotpluggable memory support, how to use and current status.
James Hoganfdabf522012-10-09 11:00:27 +0100315metag/
316 - directory with info about Linux on Meta architecture.
Nitesh Gupta35b8ea62019-10-31 10:45:54 +0530317mhi.txt
318 - Modem Host Interface
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319mips/
320 - directory with info about Linux on MIPS architecture.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500321misc-devices/
322 - directory with info about devices using the misc dev subsystem
Adrian Hunterdfe86cb2010-08-11 14:17:46 -0700323mmc/
324 - directory with info about the MMC subsystem
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500325mn10300/
326 - directory with info about the mn10300 architecture port
Henrik Austad3cf8ca12014-02-10 14:25:33 -0800327module-signing.txt
328 - Kernel module signing for increased security when loading modules.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500329mtd/
330 - directory with info about memory technology devices (flash)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331mono.txt
332 - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
Pavel Emelyanov2868f892007-11-28 16:21:39 -0800333namespaces/
334 - directory with various information about namespaces
Paul Moore8802f612006-08-03 16:45:49 -0700335netlabel/
336 - directory with information on the NetLabel subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337networking/
338 - directory with info on various aspects of networking with Linux.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500339nfc/
340 - directory relating info about Near Field Communications support.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700341nommu-mmap.txt
342 - documentation about no-mmu memory mapping support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343numastat.txt
344 - info on how to read Numa policy hit/miss statistics in sysfs.
345oops-tracing.txt
346 - how to decode those nasty internal kernel error dump messages.
Jonathan Corbet4047f8b2010-05-12 14:23:48 -0600347padata.txt
348 - An introduction to the "padata" parallel execution API
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349parisc/
350 - directory with info on using Linux on PA-RISC architecture.
351parport.txt
352 - how to use the parallel-port driver.
353parport-lowlevel.txt
354 - description and usage of the low level parallel port functions.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700355pcmcia/
356 - info on the Linux PCMCIA driver.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500357percpu-rw-semaphore.txt
358 - RCU based read-write semaphore optimized for locking for reading
Henrik Austad3cf8ca12014-02-10 14:25:33 -0800359phy.txt
360 - Description of the generic PHY framework.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700361pi-futex.txt
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500362 - documentation on lightweight priority inheritance futexes.
363pinctrl.txt
364 - info on pinctrl subsystem and the PINMUX/PINCONF and drivers
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365pnp.txt
366 - Linux Plug and Play documentation.
367power/
368 - directory with info on Linux PCI power management.
369powerpc/
370 - directory with info on using Linux with the PowerPC.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500371prctl/
372 - directory with info on the priveledge control subsystem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373preempt-locking.txt
374 - info on locking under a preemptive kernel.
Randy Dunlapb67ad182008-11-12 13:26:55 -0800375printk-formats.txt
376 - how to get printk format specifiers right
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500377pps/
378 - directory with information on the pulse-per-second support
379ptp/
380 - directory with info on support for IEEE 1588 PTP clocks in Linux.
381pwm.txt
382 - info on the pulse width modulation driver subsystem
Sergiu Iordache4126dac2011-08-13 12:34:56 -0700383ramoops.txt
384 - documentation of the ramoops oops/panic logging module.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500385rapidio/
386 - directory with info on RapidIO packet-based fabric interconnect
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700387rbtree.txt
388 - info on what red-black trees are and what they are for.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500389remoteproc.txt
390 - info on how to handle remote processor (e.g. AMP) offloads/usage.
391rfkill.txt
392 - info on the radio frequency kill switch subsystem/support.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700393robust-futex-ABI.txt
394 - documentation of the robust futex ABI.
395robust-futexes.txt
396 - a description of what robust futexes are.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500397rpmsg.txt
398 - info on the Remote Processor Messaging (rpmsg) Framework
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399rtc.txt
400 - notes on how to use the Real Time Clock (aka CMOS clock) driver.
401s390/
402 - directory with info on using Linux on the IBM S390.
J. Bruce Fields9b8eae72008-02-07 00:13:37 -0800403scheduler/
404 - directory with info on the scheduler.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405scsi/
406 - directory with info on Linux scsi support.
Randy Dunlapd410fa42011-05-19 15:59:38 -0700407security/
408 - directory that contains security-related info
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409serial/
410 - directory with info on the low level serial API.
411serial-console.txt
412 - how to set up Linux with a serial line console as the default.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700413sgi-ioc4.txt
414 - description of the SGI IOC4 PCI (multi function) device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415sh/
416 - directory with info on porting Linux to a new architecture.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500417smsc_ece1099.txt
418 -info on the smsc Keyboard Scan Expansion/GPIO Expansion device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419sound/
420 - directory with info on sound card support.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700421sparse.txt
422 - info on how to obtain and use the sparse tool for typechecking.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700423spi/
424 - overview of Linux kernel Serial Peripheral Interface (SPI) support.
Greg Kroah-Hartman8907e942005-11-18 09:31:15 -0800425stable_api_nonsense.txt
426 - info on why the kernel does not have a stable in-kernel api or abi.
427stable_kernel_rules.txt
428 - rules and procedures for the -stable kernel releases.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500429static-keys.txt
430 - info on how static keys allow debug code in hotpaths via patching
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431svga.txt
432 - short guide on selecting video modes at boot via VGA BIOS.
Rob Landley5ef43562007-10-16 23:31:25 -0700433sysfs-rules.txt
434 - How not to use sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435sysctl/
436 - directory with info on the /proc/sys/* files.
437sysrq.txt
438 - info on the magic SysRq key.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500439target/
440 - directory with info on generating TCM v4 fabric .ko modules
Jens Wiklanderca3e4eb2015-06-01 16:15:25 +0200441tee.txt
442 - info on the TEE subsystem and drivers
Henrik Austad3cf8ca12014-02-10 14:25:33 -0800443this_cpu_ops.txt
444 - List rationale behind and the way to use this_cpu operations.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500445thermal/
446 - directory with information on managing thermal issues (CPU/temp)
447trace/
448 - directory with info on tracing technologies within linux
449unaligned-memory-access.txt
450 - info on how to avoid arch breaking unaligned memory access in code.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700451unicode.txt
452 - info on the Unicode character/font mapping used in Linux.
453unshare.txt
454 - description of the Linux unshare system call.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455usb/
456 - directory with info regarding the Universal Serial Bus.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500457vDSO/
458 - directory with info regarding virtual dynamic shared objects
459vfio.txt
460 - info on Virtual Function I/O used in guest/hypervisor instances.
461vgaarbiter.txt
462 - info on enable/disable the legacy decoding on different VGA devices
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700463video-output.txt
464 - sysfs class driver interface to enable/disable a video output device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465video4linux/
466 - directory with info regarding video/TV/radio cards and linux.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500467virtual/
468 - directory with information on the various linux virtualizations.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469vm/
470 - directory with info on the Linux vm code.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500471vme_api.txt
472 - file relating info on the VME bus API in linux
Rob Landley5ef43562007-10-16 23:31:25 -0700473volatile-considered-harmful.txt
474 - Why the "volatile" type class should not be used
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700475w1/
476 - directory with documents regarding the 1-wire (w1) subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477watchdog/
478 - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500479wimax/
480 - directory with info about Intel Wireless Wimax Connections
481workqueue.txt
482 - information on the Concurrency Managed Workqueue implementation
Uwe Hermann71cced62008-10-20 09:32:21 -0700483x86/x86_64/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 - directory with info on Linux support for AMD x86-64 (Hammer) machines.
Henrik Austad8ea8f3e2014-12-26 09:26:22 +0100485xillybus.txt
486 - Overview and basic ui of xillybus driver
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500487xtensa/
488 - directory with documents relating to arch/xtensa port/implementation
489xz.txt
490 - how to make use of the XZ data compression within linux kernel
491zh_CN/
492 - directory with Chinese translations of various documents
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493zorro.txt
494 - info on writing drivers for Zorro bus devices found on Amigas.