blob: 07de7e19b4ce4b2255c5ddf0c046fa5515733203 [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
Henrik Austad3cf8ca12014-02-10 14:25:33 -080032dmatest.txt
33 - how to compile, configure and use the dmatest system.
Linus Torvalds1da177e2005-04-16 15:20:36 -070034DocBook/
35 - directory with DocBook templates etc. for kernel documentation.
Paul Gortmaker449e3a72013-02-14 15:20:54 -050036EDID/
37 - directory with info on customizing EDID for broken gfx/displays.
Greg Kroah-Hartmand36cc9d2005-11-18 09:31:11 -080038HOWTO
Jesper Juhlf6b07d32007-07-15 23:41:41 -070039 - the process and procedures of how to do Linux kernel development.
Linus Torvalds1da177e2005-04-16 15:20:36 -070040IPMI.txt
41 - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
42IRQ-affinity.txt
43 - how to select which CPU(s) handle which interrupt events on SMP.
Paul Gortmaker449e3a72013-02-14 15:20:54 -050044IRQ-domain.txt
Murilo Opsfelder Araujo453f42d2013-08-20 20:48:39 -030045 - info on interrupt numbering and setting up IRQ domains.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070046IRQ.txt
47 - description of what an IRQ is.
Paul Gortmaker449e3a72013-02-14 15:20:54 -050048Intel-IOMMU.txt
49 - basic info on the Intel IOMMU virtualization support.
50Makefile
51 - some files in Documentation dir are actually sample code to build
Linus Torvalds1da177e2005-04-16 15:20:36 -070052ManagementStyle
53 - how to (attempt to) manage kernel hackers.
Linus Torvalds1da177e2005-04-16 15:20:36 -070054RCU/
55 - directory with info on RCU (read-copy update).
Linus Torvalds1da177e2005-04-16 15:20:36 -070056SAK.txt
57 - info on Secure Attention Keys.
Rob Landley5ef43562007-10-16 23:31:25 -070058SM501.txt
59 - Silicon Motion SM501 multimedia companion chip
Jesper Juhlf6b07d32007-07-15 23:41:41 -070060SecurityBugs
61 - procedure for reporting security bugs found in the kernel.
62SubmitChecklist
63 - Linux kernel patch submission checklist.
Linus Torvalds1da177e2005-04-16 15:20:36 -070064SubmittingDrivers
65 - procedure to get a new driver source included into the kernel tree.
66SubmittingPatches
67 - procedure to get a source patch included into the kernel tree.
68VGA-softcursor.txt
69 - how to change your VGA cursor from a blinking underscore.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070070accounting/
71 - documentation on accounting and taskstats.
Len Brownb4d27302007-11-14 19:53:21 -050072acpi/
73 - info on ACPI-specific hooks in the kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070074aoe/
75 - description of AoE (ATA over Ethernet) along with config examples.
Jesper Juhl754c7972005-09-09 13:10:12 -070076applying-patches.txt
77 - description of various trees and how to apply their patches.
Linus Torvalds1da177e2005-04-16 15:20:36 -070078arm/
79 - directory with info about Linux on the ARM architecture.
Paul Gortmaker449e3a72013-02-14 15:20:54 -050080arm64/
81 - directory with info about Linux on the 64 bit ARM architecture.
Henrik Austad3cf8ca12014-02-10 14:25:33 -080082assoc_array.txt
83 - generic associative array intro.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070084atomic_ops.txt
85 - semantics and behavior of atomic and bitmask operations.
86auxdisplay/
87 - misc. LCD driver documentation (cfag12864b, ks0108).
Paul Gortmaker449e3a72013-02-14 15:20:54 -050088backlight/
89 - directory with info on controlling backlights in flat panel displays
90bad_memory.txt
91 - how to use kernel parameters to exclude bad RAM regions.
Linus Torvalds1da177e2005-04-16 15:20:36 -070092basic_profiling.txt
93 - basic instructions for those who wants to profile Linux kernel.
Henrik Austad3cf8ca12014-02-10 14:25:33 -080094bcache.txt
95 - Block-layer cache on fast SSDs to improve slow (raid) I/O performance.
Linus Torvalds1da177e2005-04-16 15:20:36 -070096binfmt_misc.txt
97 - info on the kernel support for extra binary formats.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070098blackfin/
99 - directory with documentation for the Blackfin arch.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100block/
101 - info on the Block I/O (BIO) layer.
Randy Dunlap31c00fc2008-11-13 21:33:24 +0000102blockdev/
103 - info on block devices & drivers
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500104braille-console.txt
105 - info on how to use serial devices for Braille support.
106bt8xxgpio.txt
107 - info on how to modify a bt8xx video card for GPIO usage.
Bing Zhao196be0c2009-06-02 14:29:38 -0700108btmrvl.txt
109 - info on Marvell Bluetooth driver usage.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500110bus-devices/
111 - directory with info on TI GPMC (General Purpose Memory Controller)
Randy Dunlap9fe41e42010-07-19 22:20:27 +0000112bus-virt-phys-mapping.txt
113 - how to access I/O mapped memory from within device drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114cachetlb.txt
115 - describes the cache/TLB flushing interfaces Linux uses.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116cdrom/
117 - directory with information on the CD-ROM drivers that Linux has.
Thadeu Lima de Souza Cascardo21acb9c2009-02-04 10:12:08 +0100118cgroups/
119 - cgroups features, including cpusets and memory controller.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500120circular-buffers.txt
121 - how to make use of the existing circular buffer infrastructure
122clk.txt
123 - info on the common clock framework
124coccinelle.txt
125 - info on how to get and use the Coccinelle code checking tool.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700126connector/
127 - docs on the netlink based userspace<->kernel space communication mod.
128console/
129 - documentation on Linux console drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130cpu-freq/
131 - info on CPU frequency and voltage scaling.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700132cpu-hotplug.txt
133 - document describing CPU hotplug support in the Linux kernel.
134cpu-load.txt
135 - document describing how CPU load statistics are collected.
Venkatesh Pallipadife8e2882008-02-14 00:16:13 -0500136cpuidle/
137 - info on CPU_IDLE, CPU idle state management subsystem.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700138cputopology.txt
139 - documentation on how CPU topology info is exported via sysfs.
Bob Pearsonfbedceb2012-03-23 15:02:22 -0700140crc32.txt
141 - brief tutorial on CRC computation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142cris/
143 - directory with info about Linux on CRIS architecture.
144crypto/
145 - directory with info on the Crypto API.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700146dcdbas.txt
147 - information on the Dell Systems Management Base Driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148debugging-modules.txt
149 - some notes on debugging modules after Linux 2.6.3.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500150debugging-via-ohci1394.txt
151 - how to use firewire like a hardware debugger memory reader.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700152dell_rbu.txt
153 - document demonstrating the use of the Dell Remote BIOS Update driver.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500154development-process/
155 - how to work with the mainline kernel development process.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156device-mapper/
157 - directory with info on Device Mapper.
158devices.txt
159 - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500160devicetree/
161 - directory with info on device tree files used by OF/PowerPC/ARM
162digsig.txt
163 -info on the Digital Signature Verification API
164dma-buf-sharing.txt
165 - the DMA Buffer Sharing API Guide
166dmaengine.txt
167 -the DMA Engine API Guide
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700168dontdiff
169 - file containing a list of files that should never be diff'ed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170driver-model/
171 - directory with info about Linux driver model.
172dvb/
173 - info on Linux Digital Video Broadcast (DVB) subsystem.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500174dynamic-debug-howto.txt
175 - how to use the dynamic debug (dyndbg) feature.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176early-userspace/
177 - info about initramfs, klibc, and userspace early during boot.
Adrian Bunk4a6b88c2008-02-07 00:13:33 -0800178edac.txt
179 - information on EDAC - Error Detection And Correction
Henrik Austad3cf8ca12014-02-10 14:25:33 -0800180efi-stub.txt
181 - How to use the EFI boot stub to bypass GRUB or elilo on EFI systems.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182eisa.txt
183 - info on EISA bus support.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500184email-clients.txt
185 - info on how to use e-mail to send un-mangled (git) patches.
186extcon/
187 - directory with porting guide for Android kernel switch driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700188fault-injection/
189 - dir with docs about the fault injection capabilities infrastructure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190fb/
191 - directory with info on the frame buffer graphics abstraction layer.
192filesystems/
J. Bruce Fields4f3b19c2007-09-24 18:52:09 -0400193 - info on the vfs and the various filesystems that Linux supports.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194firmware_class/
195 - request_firmware() hotplug interface info.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500196flexible-arrays.txt
197 - how to make use of flexible sized arrays in linux
Alessandro Rubini022c6742013-06-18 23:47:24 +0200198fmc/
199 - information about the FMC bus abstraction
Adrian Bunk0868ff72008-02-03 15:54:28 +0200200frv/
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700201 - Fujitsu FR-V Linux documentation.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500202futex-requeue-pi.txt
203 - info on requeueing of tasks from a non-PI futex to a PI futex
204gcov.txt
205 - use of GCC's coverage testing tool "gcov" with the Linux kernel
Henrik Austad3cf8ca12014-02-10 14:25:33 -0800206gpio/
207 - gpio related documentation
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500208hid/
209 - directory with information on human interface devices
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210highuid.txt
211 - notes on the change from 16 bit to 32 bit user/group IDs.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500212hwspinlock.txt
213 - hardware spinlock provides hardware assistance for synchronization
Thomas Gleixner3833eec2008-03-05 18:28:15 +0100214timers/
215 - info on the timer related topics
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216hw_random.txt
217 - info on Linux support for random number generator in i8xx chipsets.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700218hwmon/
219 - directory with docs on various hardware monitoring drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220i2c/
221 - directory with info about the I2C bus/protocol (2 wire, kHz speed).
222i2o/
223 - directory with info about the Linux I2O subsystem.
Uwe Hermann71cced62008-10-20 09:32:21 -0700224x86/i386/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 - directory with info about Linux on Intel 32 bit architecture.
226ia64/
227 - directory with info about Linux on Intel 64 bit architecture.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700228infiniband/
229 - directory with documents concerning Linux InfiniBand support.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500230init.txt
231 - what to do when the kernel can't find the 1st process to run.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232initrd.txt
233 - how to use the RAM disk as an initial/temporary root filesystem.
234input/
235 - info on Linux input device support.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500236intel_txt.txt
237 - info on intel Trusted Execution Technology (intel TXT).
Randy Dunlap9fe41e42010-07-19 22:20:27 +0000238io-mapping.txt
239 - description of io_mapping functions in linux/io-mapping.h
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240io_ordering.txt
241 - info on ordering I/O writes to memory-mapped addresses.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700242ioctl/
243 - directory with documents describing various IOCTL calls.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244iostats.txt
245 - info on I/O statistics Linux kernel provides.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700246irqflags-tracing.txt
247 - how to use the irq-flags tracing feature.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248isapnp.txt
249 - info on Linux ISA Plug & Play support.
250isdn/
251 - directory with info on the Linux ISDN support, and supported cards.
252java.txt
253 - info on the in-kernel binary support for Java(tm).
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500254ja_JP/
255 - directory with Japanese translations of various documents
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256kbuild/
257 - directory with info about the kernel build process.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700258kdump/
259 - directory with mini HowTo on getting the crash dump code to work.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260kernel-doc-nano-HOWTO.txt
261 - mini HowTo on generation and location of kernel documentation files.
262kernel-docs.txt
263 - listing of various WWW + books that document kernel internals.
264kernel-parameters.txt
265 - summary listing of command line / boot prompt args for the kernel.
Henrik Austad3cf8ca12014-02-10 14:25:33 -0800266kernel-per-CPU-kthreads.txt
267 - List of all per-CPU kthreads and how they introduce jitter.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500268kmemcheck.txt
269 - info on dynamic checker that detects uses of uninitialized memory.
270kmemleak.txt
271 - info on how to make use of the kernel memory leak detection system
272ko_KR/
273 - directory with Korean translations of various documents
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274kobject.txt
275 - info of the kobject infrastructure of the Linux kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700276kprobes.txt
277 - documents the kernel probes debugging feature.
278kref.txt
279 - docs on adding reference counters (krefs) to kernel objects.
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.
288lockdep-design.txt
289 - documentation on the runtime locking correctness validator.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500290lockstat.txt
291 - info on collecting statistics on locks (and contention).
Jean Delvarefd058732012-10-21 12:05:51 +0200292lockup-watchdogs.txt
293 - info on soft and hard lockup detectors (aka nmi_watchdog).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294logo.gif
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700295 - full colour GIF image of Linux logo (penguin - Tux).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296logo.txt
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700297 - info on creator of above logo & site to get additional images from.
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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302md.txt
303 - info on boot arguments for the multiple devices driver.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500304media-framework.txt
305 - info on media framework, its data structures, functions and usage.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700306memory-barriers.txt
307 - info on Linux kernel memory barriers.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500308memory-devices/
309 - directory with info on parts like the Texas Instruments EMIF driver
Rob Landley5ef43562007-10-16 23:31:25 -0700310memory-hotplug.txt
311 - Hotpluggable memory support, how to use and current status.
James Hoganfdabf522012-10-09 11:00:27 +0100312metag/
313 - directory with info about Linux on Meta architecture.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314mips/
315 - directory with info about Linux on MIPS architecture.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500316misc-devices/
317 - directory with info about devices using the misc dev subsystem
Adrian Hunterdfe86cb2010-08-11 14:17:46 -0700318mmc/
319 - directory with info about the MMC subsystem
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500320mn10300/
321 - directory with info about the mn10300 architecture port
Henrik Austad3cf8ca12014-02-10 14:25:33 -0800322module-signing.txt
323 - Kernel module signing for increased security when loading modules.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500324mtd/
325 - directory with info about memory technology devices (flash)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326mono.txt
327 - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700328mutex-design.txt
329 - info on the generic mutex subsystem.
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
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700396rt-mutex-design.txt
397 - description of the RealTime mutex implementation design.
398rt-mutex.txt
399 - desc. of RT-mutex subsystem with PI (Priority Inheritance) support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400rtc.txt
401 - notes on how to use the Real Time Clock (aka CMOS clock) driver.
402s390/
403 - directory with info on using Linux on the IBM S390.
J. Bruce Fields9b8eae72008-02-07 00:13:37 -0800404scheduler/
405 - directory with info on the scheduler.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406scsi/
407 - directory with info on Linux scsi support.
Randy Dunlapd410fa42011-05-19 15:59:38 -0700408security/
409 - directory that contains security-related info
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410serial/
411 - directory with info on the low level serial API.
412serial-console.txt
413 - how to set up Linux with a serial line console as the default.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700414sgi-ioc4.txt
415 - description of the SGI IOC4 PCI (multi function) device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416sgi-visws.txt
417 - short blurb on the SGI Visual Workstations.
418sh/
419 - directory with info on porting Linux to a new architecture.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500420smsc_ece1099.txt
421 -info on the smsc Keyboard Scan Expansion/GPIO Expansion device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422sound/
423 - directory with info on sound card support.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700424sparse.txt
425 - info on how to obtain and use the sparse tool for typechecking.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700426spi/
427 - overview of Linux kernel Serial Peripheral Interface (SPI) support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428spinlocks.txt
429 - info on using spinlocks to provide exclusive access in kernel.
Greg Kroah-Hartman8907e942005-11-18 09:31:15 -0800430stable_api_nonsense.txt
431 - info on why the kernel does not have a stable in-kernel api or abi.
432stable_kernel_rules.txt
433 - rules and procedures for the -stable kernel releases.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500434static-keys.txt
435 - info on how static keys allow debug code in hotpaths via patching
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436svga.txt
437 - short guide on selecting video modes at boot via VGA BIOS.
Rob Landley5ef43562007-10-16 23:31:25 -0700438sysfs-rules.txt
439 - How not to use sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440sysctl/
441 - directory with info on the /proc/sys/* files.
442sysrq.txt
443 - info on the magic SysRq key.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500444target/
445 - directory with info on generating TCM v4 fabric .ko modules
Henrik Austad3cf8ca12014-02-10 14:25:33 -0800446this_cpu_ops.txt
447 - List rationale behind and the way to use this_cpu operations.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500448thermal/
449 - directory with information on managing thermal issues (CPU/temp)
450trace/
451 - directory with info on tracing technologies within linux
452unaligned-memory-access.txt
453 - info on how to avoid arch breaking unaligned memory access in code.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700454unicode.txt
455 - info on the Unicode character/font mapping used in Linux.
456unshare.txt
457 - description of the Linux unshare system call.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458usb/
459 - directory with info regarding the Universal Serial Bus.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500460vDSO/
461 - directory with info regarding virtual dynamic shared objects
462vfio.txt
463 - info on Virtual Function I/O used in guest/hypervisor instances.
464vgaarbiter.txt
465 - info on enable/disable the legacy decoding on different VGA devices
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700466video-output.txt
467 - sysfs class driver interface to enable/disable a video output device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468video4linux/
469 - directory with info regarding video/TV/radio cards and linux.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500470virtual/
471 - directory with information on the various linux virtualizations.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472vm/
473 - directory with info on the Linux vm code.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500474vme_api.txt
475 - file relating info on the VME bus API in linux
Rob Landley5ef43562007-10-16 23:31:25 -0700476volatile-considered-harmful.txt
477 - Why the "volatile" type class should not be used
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700478w1/
479 - directory with documents regarding the 1-wire (w1) subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480watchdog/
481 - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500482wimax/
483 - directory with info about Intel Wireless Wimax Connections
484workqueue.txt
485 - information on the Concurrency Managed Workqueue implementation
Henrik Austad3cf8ca12014-02-10 14:25:33 -0800486ww-mutex-design.txt
487 - Intro to Mutex wait/would deadlock handling.s
Uwe Hermann71cced62008-10-20 09:32:21 -0700488x86/x86_64/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489 - directory with info on Linux support for AMD x86-64 (Hammer) machines.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500490xtensa/
491 - directory with documents relating to arch/xtensa port/implementation
492xz.txt
493 - how to make use of the XZ data compression within linux kernel
494zh_CN/
495 - directory with Chinese translations of various documents
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496zorro.txt
497 - info on writing drivers for Zorro bus devices found on Amigas.