blob: cd077ca0e1b86dfba53b3bd2d0fa62724eb24eb4 [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
49 - some files in Documentation dir are actually sample code to build
Linus Torvalds1da177e2005-04-16 15:20:36 -070050ManagementStyle
51 - how to (attempt to) manage kernel hackers.
Linus Torvalds1da177e2005-04-16 15:20:36 -070052RCU/
53 - directory with info on RCU (read-copy update).
Linus Torvalds1da177e2005-04-16 15:20:36 -070054SAK.txt
55 - info on Secure Attention Keys.
Rob Landley5ef43562007-10-16 23:31:25 -070056SM501.txt
57 - Silicon Motion SM501 multimedia companion chip
Jesper Juhlf6b07d32007-07-15 23:41:41 -070058SecurityBugs
59 - procedure for reporting security bugs found in the kernel.
60SubmitChecklist
61 - Linux kernel patch submission checklist.
Linus Torvalds1da177e2005-04-16 15:20:36 -070062SubmittingDrivers
63 - procedure to get a new driver source included into the kernel tree.
64SubmittingPatches
65 - procedure to get a source patch included into the kernel tree.
66VGA-softcursor.txt
67 - how to change your VGA cursor from a blinking underscore.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070068accounting/
69 - documentation on accounting and taskstats.
Len Brownb4d27302007-11-14 19:53:21 -050070acpi/
71 - info on ACPI-specific hooks in the kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070072aoe/
73 - description of AoE (ATA over Ethernet) along with config examples.
Jesper Juhl754c7972005-09-09 13:10:12 -070074applying-patches.txt
75 - description of various trees and how to apply their patches.
Linus Torvalds1da177e2005-04-16 15:20:36 -070076arm/
77 - directory with info about Linux on the ARM architecture.
Paul Gortmaker449e3a72013-02-14 15:20:54 -050078arm64/
79 - directory with info about Linux on the 64 bit ARM architecture.
Henrik Austad3cf8ca12014-02-10 14:25:33 -080080assoc_array.txt
81 - generic associative array intro.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070082atomic_ops.txt
83 - semantics and behavior of atomic and bitmask operations.
84auxdisplay/
85 - misc. LCD driver documentation (cfag12864b, ks0108).
Paul Gortmaker449e3a72013-02-14 15:20:54 -050086backlight/
87 - directory with info on controlling backlights in flat panel displays
88bad_memory.txt
89 - how to use kernel parameters to exclude bad RAM regions.
Linus Torvalds1da177e2005-04-16 15:20:36 -070090basic_profiling.txt
91 - basic instructions for those who wants to profile Linux kernel.
Henrik Austad3cf8ca12014-02-10 14:25:33 -080092bcache.txt
93 - Block-layer cache on fast SSDs to improve slow (raid) I/O performance.
Linus Torvalds1da177e2005-04-16 15:20:36 -070094binfmt_misc.txt
95 - info on the kernel support for extra binary formats.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070096blackfin/
97 - directory with documentation for the Blackfin arch.
Linus Torvalds1da177e2005-04-16 15:20:36 -070098block/
99 - info on the Block I/O (BIO) layer.
Randy Dunlap31c00fc2008-11-13 21:33:24 +0000100blockdev/
101 - info on block devices & drivers
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500102braille-console.txt
103 - info on how to use serial devices for Braille support.
104bt8xxgpio.txt
105 - info on how to modify a bt8xx video card for GPIO usage.
Bing Zhao196be0c2009-06-02 14:29:38 -0700106btmrvl.txt
107 - info on Marvell Bluetooth driver usage.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500108bus-devices/
109 - directory with info on TI GPMC (General Purpose Memory Controller)
Randy Dunlap9fe41e42010-07-19 22:20:27 +0000110bus-virt-phys-mapping.txt
111 - how to access I/O mapped memory from within device drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112cachetlb.txt
113 - describes the cache/TLB flushing interfaces Linux uses.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114cdrom/
115 - directory with information on the CD-ROM drivers that Linux has.
Thadeu Lima de Souza Cascardo21acb9c2009-02-04 10:12:08 +0100116cgroups/
117 - cgroups features, including cpusets and memory controller.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500118circular-buffers.txt
119 - how to make use of the existing circular buffer infrastructure
120clk.txt
121 - info on the common clock framework
122coccinelle.txt
123 - info on how to get and use the Coccinelle code checking tool.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700124connector/
125 - docs on the netlink based userspace<->kernel space communication mod.
126console/
127 - documentation on Linux console drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128cpu-freq/
129 - info on CPU frequency and voltage scaling.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700130cpu-hotplug.txt
131 - document describing CPU hotplug support in the Linux kernel.
132cpu-load.txt
133 - document describing how CPU load statistics are collected.
Venkatesh Pallipadife8e2882008-02-14 00:16:13 -0500134cpuidle/
135 - info on CPU_IDLE, CPU idle state management subsystem.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700136cputopology.txt
137 - documentation on how CPU topology info is exported via sysfs.
Bob Pearsonfbedceb2012-03-23 15:02:22 -0700138crc32.txt
139 - brief tutorial on CRC computation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140cris/
141 - directory with info about Linux on CRIS architecture.
142crypto/
143 - directory with info on the Crypto API.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700144dcdbas.txt
145 - information on the Dell Systems Management Base Driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146debugging-modules.txt
147 - some notes on debugging modules after Linux 2.6.3.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500148debugging-via-ohci1394.txt
149 - how to use firewire like a hardware debugger memory reader.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700150dell_rbu.txt
151 - document demonstrating the use of the Dell Remote BIOS Update driver.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500152development-process/
153 - how to work with the mainline kernel development process.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154device-mapper/
155 - directory with info on Device Mapper.
156devices.txt
157 - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500158devicetree/
159 - directory with info on device tree files used by OF/PowerPC/ARM
160digsig.txt
161 -info on the Digital Signature Verification API
162dma-buf-sharing.txt
163 - the DMA Buffer Sharing API Guide
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700164dontdiff
165 - file containing a list of files that should never be diff'ed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166driver-model/
167 - directory with info about Linux driver model.
168dvb/
169 - info on Linux Digital Video Broadcast (DVB) subsystem.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500170dynamic-debug-howto.txt
171 - how to use the dynamic debug (dyndbg) feature.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172early-userspace/
173 - info about initramfs, klibc, and userspace early during boot.
Adrian Bunk4a6b88c2008-02-07 00:13:33 -0800174edac.txt
175 - information on EDAC - Error Detection And Correction
Henrik Austad3cf8ca12014-02-10 14:25:33 -0800176efi-stub.txt
177 - How to use the EFI boot stub to bypass GRUB or elilo on EFI systems.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178eisa.txt
179 - info on EISA bus support.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500180email-clients.txt
181 - info on how to use e-mail to send un-mangled (git) patches.
182extcon/
183 - directory with porting guide for Android kernel switch driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700184fault-injection/
185 - dir with docs about the fault injection capabilities infrastructure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186fb/
187 - directory with info on the frame buffer graphics abstraction layer.
188filesystems/
J. Bruce Fields4f3b19c2007-09-24 18:52:09 -0400189 - info on the vfs and the various filesystems that Linux supports.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190firmware_class/
191 - request_firmware() hotplug interface info.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500192flexible-arrays.txt
193 - how to make use of flexible sized arrays in linux
Alessandro Rubini022c6742013-06-18 23:47:24 +0200194fmc/
195 - information about the FMC bus abstraction
Adrian Bunk0868ff72008-02-03 15:54:28 +0200196frv/
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700197 - Fujitsu FR-V Linux documentation.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500198futex-requeue-pi.txt
199 - info on requeueing of tasks from a non-PI futex to a PI futex
200gcov.txt
201 - use of GCC's coverage testing tool "gcov" with the Linux kernel
Henrik Austad3cf8ca12014-02-10 14:25:33 -0800202gpio/
203 - gpio related documentation
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500204hid/
205 - directory with information on human interface devices
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206highuid.txt
207 - notes on the change from 16 bit to 32 bit user/group IDs.
Henrik Austad8ea8f3e2014-12-26 09:26:22 +0100208hsi.txt
209 - HSI subsystem overview.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500210hwspinlock.txt
211 - hardware spinlock provides hardware assistance for synchronization
Thomas Gleixner3833eec2008-03-05 18:28:15 +0100212timers/
213 - info on the timer related topics
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214hw_random.txt
215 - info on Linux support for random number generator in i8xx chipsets.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700216hwmon/
217 - directory with docs on various hardware monitoring drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218i2c/
219 - directory with info about the I2C bus/protocol (2 wire, kHz speed).
220i2o/
221 - directory with info about the Linux I2O subsystem.
Uwe Hermann71cced62008-10-20 09:32:21 -0700222x86/i386/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 - directory with info about Linux on Intel 32 bit architecture.
224ia64/
225 - directory with info about Linux on Intel 64 bit architecture.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700226infiniband/
227 - directory with documents concerning Linux InfiniBand support.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500228init.txt
229 - what to do when the kernel can't find the 1st process to run.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230initrd.txt
231 - how to use the RAM disk as an initial/temporary root filesystem.
232input/
233 - info on Linux input device support.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500234intel_txt.txt
235 - info on intel Trusted Execution Technology (intel TXT).
Randy Dunlap9fe41e42010-07-19 22:20:27 +0000236io-mapping.txt
237 - description of io_mapping functions in linux/io-mapping.h
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238io_ordering.txt
239 - info on ordering I/O writes to memory-mapped addresses.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700240ioctl/
241 - directory with documents describing various IOCTL calls.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242iostats.txt
243 - info on I/O statistics Linux kernel provides.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700244irqflags-tracing.txt
245 - how to use the irq-flags tracing feature.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246isapnp.txt
247 - info on Linux ISA Plug & Play support.
248isdn/
249 - directory with info on the Linux ISDN support, and supported cards.
250java.txt
251 - info on the in-kernel binary support for Java(tm).
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500252ja_JP/
253 - directory with Japanese translations of various documents
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254kbuild/
255 - directory with info about the kernel build process.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700256kdump/
257 - directory with mini HowTo on getting the crash dump code to work.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258kernel-doc-nano-HOWTO.txt
259 - mini HowTo on generation and location of kernel documentation files.
260kernel-docs.txt
261 - listing of various WWW + books that document kernel internals.
262kernel-parameters.txt
263 - summary listing of command line / boot prompt args for the kernel.
Henrik Austad3cf8ca12014-02-10 14:25:33 -0800264kernel-per-CPU-kthreads.txt
265 - List of all per-CPU kthreads and how they introduce jitter.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500266kmemcheck.txt
267 - info on dynamic checker that detects uses of uninitialized memory.
268kmemleak.txt
269 - info on how to make use of the kernel memory leak detection system
270ko_KR/
271 - directory with Korean translations of various documents
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272kobject.txt
273 - info of the kobject infrastructure of the Linux kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700274kprobes.txt
275 - documents the kernel probes debugging feature.
276kref.txt
277 - docs on adding reference counters (krefs) to kernel objects.
Henrik Austad8ea8f3e2014-12-26 09:26:22 +0100278kselftest.txt
279 - small unittests for (some) individual codepaths in the kernel.
Carlos Corbachod6ff3652008-02-09 01:32:03 +0000280laptops/
281 - directory with laptop related info and laptop driver documentation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282ldm.txt
283 - a brief description of LDM (Windows Dynamic Disks).
Antonio Ospite9a684e12011-04-04 15:08:46 -0700284leds/
285 - directory with info about LED handling under Linux.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700286local_ops.txt
287 - semantics and behavior of local atomic operations.
Davidlohr Bueso214e0ae2014-07-30 13:41:55 -0700288locking/
289 - directory with info about kernel locking primitives
Jean Delvarefd058732012-10-21 12:05:51 +0200290lockup-watchdogs.txt
291 - info on soft and hard lockup detectors (aka nmi_watchdog).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292logo.gif
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700293 - full colour GIF image of Linux logo (penguin - Tux).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294logo.txt
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700295 - info on creator of above logo & site to get additional images from.
Henrik Austad8ea8f3e2014-12-26 09:26:22 +0100296lzo.txt
297 - kernel LZO decompressor input formats
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298m68k/
299 - directory with info about Linux on Motorola 68k architecture.
300magic-number.txt
301 - list of magic numbers used to mark/protect kernel data structures.
Henrik Austad8ea8f3e2014-12-26 09:26:22 +0100302mailbox.txt
303 - How to write drivers for the common mailbox framework (IPC).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304md.txt
305 - info on boot arguments for the multiple devices driver.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500306media-framework.txt
307 - info on media framework, its data structures, functions and usage.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700308memory-barriers.txt
309 - info on Linux kernel memory barriers.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500310memory-devices/
311 - directory with info on parts like the Texas Instruments EMIF driver
Rob Landley5ef43562007-10-16 23:31:25 -0700312memory-hotplug.txt
313 - Hotpluggable memory support, how to use and current status.
James Hoganfdabf522012-10-09 11:00:27 +0100314metag/
315 - directory with info about Linux on Meta architecture.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316mips/
317 - directory with info about Linux on MIPS architecture.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500318misc-devices/
319 - directory with info about devices using the misc dev subsystem
Adrian Hunterdfe86cb2010-08-11 14:17:46 -0700320mmc/
321 - directory with info about the MMC subsystem
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500322mn10300/
323 - directory with info about the mn10300 architecture port
Henrik Austad3cf8ca12014-02-10 14:25:33 -0800324module-signing.txt
325 - Kernel module signing for increased security when loading modules.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500326mtd/
327 - directory with info about memory technology devices (flash)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328mono.txt
329 - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
Pavel Emelyanov2868f892007-11-28 16:21:39 -0800330namespaces/
331 - directory with various information about namespaces
Paul Moore8802f612006-08-03 16:45:49 -0700332netlabel/
333 - directory with information on the NetLabel subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334networking/
335 - directory with info on various aspects of networking with Linux.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500336nfc/
337 - directory relating info about Near Field Communications support.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700338nommu-mmap.txt
339 - documentation about no-mmu memory mapping support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340numastat.txt
341 - info on how to read Numa policy hit/miss statistics in sysfs.
342oops-tracing.txt
343 - how to decode those nasty internal kernel error dump messages.
Jonathan Corbet4047f8b2010-05-12 14:23:48 -0600344padata.txt
345 - An introduction to the "padata" parallel execution API
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346parisc/
347 - directory with info on using Linux on PA-RISC architecture.
348parport.txt
349 - how to use the parallel-port driver.
350parport-lowlevel.txt
351 - description and usage of the low level parallel port functions.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700352pcmcia/
353 - info on the Linux PCMCIA driver.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500354percpu-rw-semaphore.txt
355 - RCU based read-write semaphore optimized for locking for reading
Henrik Austad3cf8ca12014-02-10 14:25:33 -0800356phy.txt
357 - Description of the generic PHY framework.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700358pi-futex.txt
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500359 - documentation on lightweight priority inheritance futexes.
360pinctrl.txt
361 - info on pinctrl subsystem and the PINMUX/PINCONF and drivers
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362pnp.txt
363 - Linux Plug and Play documentation.
364power/
365 - directory with info on Linux PCI power management.
366powerpc/
367 - directory with info on using Linux with the PowerPC.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500368prctl/
369 - directory with info on the priveledge control subsystem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370preempt-locking.txt
371 - info on locking under a preemptive kernel.
Randy Dunlapb67ad182008-11-12 13:26:55 -0800372printk-formats.txt
373 - how to get printk format specifiers right
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500374pps/
375 - directory with information on the pulse-per-second support
376ptp/
377 - directory with info on support for IEEE 1588 PTP clocks in Linux.
378pwm.txt
379 - info on the pulse width modulation driver subsystem
Sergiu Iordache4126dac2011-08-13 12:34:56 -0700380ramoops.txt
381 - documentation of the ramoops oops/panic logging module.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500382rapidio/
383 - directory with info on RapidIO packet-based fabric interconnect
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700384rbtree.txt
385 - info on what red-black trees are and what they are for.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500386remoteproc.txt
387 - info on how to handle remote processor (e.g. AMP) offloads/usage.
388rfkill.txt
389 - info on the radio frequency kill switch subsystem/support.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700390robust-futex-ABI.txt
391 - documentation of the robust futex ABI.
392robust-futexes.txt
393 - a description of what robust futexes are.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500394rpmsg.txt
395 - info on the Remote Processor Messaging (rpmsg) Framework
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396rtc.txt
397 - notes on how to use the Real Time Clock (aka CMOS clock) driver.
398s390/
399 - directory with info on using Linux on the IBM S390.
J. Bruce Fields9b8eae72008-02-07 00:13:37 -0800400scheduler/
401 - directory with info on the scheduler.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402scsi/
403 - directory with info on Linux scsi support.
Randy Dunlapd410fa42011-05-19 15:59:38 -0700404security/
405 - directory that contains security-related info
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406serial/
407 - directory with info on the low level serial API.
408serial-console.txt
409 - how to set up Linux with a serial line console as the default.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700410sgi-ioc4.txt
411 - description of the SGI IOC4 PCI (multi function) device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412sh/
413 - directory with info on porting Linux to a new architecture.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500414smsc_ece1099.txt
415 -info on the smsc Keyboard Scan Expansion/GPIO Expansion device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416sound/
417 - directory with info on sound card support.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700418sparse.txt
419 - info on how to obtain and use the sparse tool for typechecking.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700420spi/
421 - overview of Linux kernel Serial Peripheral Interface (SPI) support.
Greg Kroah-Hartman8907e942005-11-18 09:31:15 -0800422stable_api_nonsense.txt
423 - info on why the kernel does not have a stable in-kernel api or abi.
424stable_kernel_rules.txt
425 - rules and procedures for the -stable kernel releases.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500426static-keys.txt
427 - info on how static keys allow debug code in hotpaths via patching
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428svga.txt
429 - short guide on selecting video modes at boot via VGA BIOS.
Rob Landley5ef43562007-10-16 23:31:25 -0700430sysfs-rules.txt
431 - How not to use sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432sysctl/
433 - directory with info on the /proc/sys/* files.
434sysrq.txt
435 - info on the magic SysRq key.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500436target/
437 - directory with info on generating TCM v4 fabric .ko modules
Henrik Austad3cf8ca12014-02-10 14:25:33 -0800438this_cpu_ops.txt
439 - List rationale behind and the way to use this_cpu operations.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500440thermal/
441 - directory with information on managing thermal issues (CPU/temp)
442trace/
443 - directory with info on tracing technologies within linux
444unaligned-memory-access.txt
445 - info on how to avoid arch breaking unaligned memory access in code.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700446unicode.txt
447 - info on the Unicode character/font mapping used in Linux.
448unshare.txt
449 - description of the Linux unshare system call.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450usb/
451 - directory with info regarding the Universal Serial Bus.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500452vDSO/
453 - directory with info regarding virtual dynamic shared objects
454vfio.txt
455 - info on Virtual Function I/O used in guest/hypervisor instances.
456vgaarbiter.txt
457 - info on enable/disable the legacy decoding on different VGA devices
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700458video-output.txt
459 - sysfs class driver interface to enable/disable a video output device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460video4linux/
461 - directory with info regarding video/TV/radio cards and linux.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500462virtual/
463 - directory with information on the various linux virtualizations.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464vm/
465 - directory with info on the Linux vm code.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500466vme_api.txt
467 - file relating info on the VME bus API in linux
Rob Landley5ef43562007-10-16 23:31:25 -0700468volatile-considered-harmful.txt
469 - Why the "volatile" type class should not be used
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700470w1/
471 - directory with documents regarding the 1-wire (w1) subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472watchdog/
473 - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500474wimax/
475 - directory with info about Intel Wireless Wimax Connections
476workqueue.txt
477 - information on the Concurrency Managed Workqueue implementation
Uwe Hermann71cced62008-10-20 09:32:21 -0700478x86/x86_64/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 - directory with info on Linux support for AMD x86-64 (Hammer) machines.
Henrik Austad8ea8f3e2014-12-26 09:26:22 +0100480xillybus.txt
481 - Overview and basic ui of xillybus driver
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500482xtensa/
483 - directory with documents relating to arch/xtensa port/implementation
484xz.txt
485 - how to make use of the XZ data compression within linux kernel
486zh_CN/
487 - directory with Chinese translations of various documents
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488zorro.txt
489 - info on writing drivers for Zorro bus devices found on Amigas.