blob: 4382778001039c7fc6595f7659895a7301533ba8 [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.
5Please try and keep the descriptions small enough to fit on one line.
6 Thanks -- Paul G.
7
8Following translations are available on the WWW:
9
10 - Japanese, maintained by the JF Project (JF@linux.or.jp), at
11 http://www.linux.or.jp/JF/
12
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
23 - how the boss likes the C code in the kernel to look.
24DMA-API.txt
25 - DMA API, pci_ API & extensions for non-consistent memory machines.
Rob Landley5ef43562007-10-16 23:31:25 -070026DMA-ISA-LPC.txt
27 - How to do DMA with ISA (and LPC) devices.
Linus Torvalds1da177e2005-04-16 15:20:36 -070028DocBook/
29 - directory with DocBook templates etc. for kernel documentation.
Greg Kroah-Hartmand36cc9d2005-11-18 09:31:11 -080030HOWTO
Jesper Juhlf6b07d32007-07-15 23:41:41 -070031 - the process and procedures of how to do Linux kernel development.
Linus Torvalds1da177e2005-04-16 15:20:36 -070032IO-mapping.txt
33 - how to access I/O mapped memory from within device drivers.
34IPMI.txt
35 - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
36IRQ-affinity.txt
37 - how to select which CPU(s) handle which interrupt events on SMP.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070038IRQ.txt
39 - description of what an IRQ is.
Linus Torvalds1da177e2005-04-16 15:20:36 -070040ManagementStyle
41 - how to (attempt to) manage kernel hackers.
42MSI-HOWTO.txt
43 - the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ.
44RCU/
45 - directory with info on RCU (read-copy update).
46README.DAC960
47 - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070048README.cycladesZ
49 - info on Cyclades-Z firmware loading.
Linus Torvalds1da177e2005-04-16 15:20:36 -070050SAK.txt
51 - info on Secure Attention Keys.
Rob Landley5ef43562007-10-16 23:31:25 -070052SM501.txt
53 - Silicon Motion SM501 multimedia companion chip
Jesper Juhlf6b07d32007-07-15 23:41:41 -070054SecurityBugs
55 - procedure for reporting security bugs found in the kernel.
56SubmitChecklist
57 - Linux kernel patch submission checklist.
Linus Torvalds1da177e2005-04-16 15:20:36 -070058SubmittingDrivers
59 - procedure to get a new driver source included into the kernel tree.
60SubmittingPatches
61 - procedure to get a source patch included into the kernel tree.
62VGA-softcursor.txt
63 - how to change your VGA cursor from a blinking underscore.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070064accounting/
65 - documentation on accounting and taskstats.
Len Brownb4d27302007-11-14 19:53:21 -050066acpi/
67 - info on ACPI-specific hooks in the kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070068aoe/
69 - description of AoE (ATA over Ethernet) along with config examples.
Jesper Juhl754c7972005-09-09 13:10:12 -070070applying-patches.txt
71 - description of various trees and how to apply their patches.
Linus Torvalds1da177e2005-04-16 15:20:36 -070072arm/
73 - directory with info about Linux on the ARM architecture.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070074atomic_ops.txt
75 - semantics and behavior of atomic and bitmask operations.
76auxdisplay/
77 - misc. LCD driver documentation (cfag12864b, ks0108).
Linus Torvalds1da177e2005-04-16 15:20:36 -070078basic_profiling.txt
79 - basic instructions for those who wants to profile Linux kernel.
80binfmt_misc.txt
81 - info on the kernel support for extra binary formats.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070082blackfin/
83 - directory with documentation for the Blackfin arch.
Linus Torvalds1da177e2005-04-16 15:20:36 -070084block/
85 - info on the Block I/O (BIO) layer.
86cachetlb.txt
87 - describes the cache/TLB flushing interfaces Linux uses.
88cciss.txt
89 - info, major/minor #'s for Compaq's SMART Array Controllers.
90cdrom/
91 - directory with information on the CD-ROM drivers that Linux has.
Linus Torvalds1da177e2005-04-16 15:20:36 -070092computone.txt
93 - info on Computone Intelliport II/Plus Multiport Serial Driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070094connector/
95 - docs on the netlink based userspace<->kernel space communication mod.
96console/
97 - documentation on Linux console drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -070098cpqarray.txt
99 - info on using Compaq's SMART2 Intelligent Disk Array Controllers.
100cpu-freq/
101 - info on CPU frequency and voltage scaling.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700102cpu-hotplug.txt
103 - document describing CPU hotplug support in the Linux kernel.
104cpu-load.txt
105 - document describing how CPU load statistics are collected.
Venkatesh Pallipadife8e2882008-02-14 00:16:13 -0500106cpuidle/
107 - info on CPU_IDLE, CPU idle state management subsystem.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700108cpusets.txt
109 - documents the cpusets feature; assign CPUs and Mem to a set of tasks.
110cputopology.txt
111 - documentation on how CPU topology info is exported via sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112cris/
113 - directory with info about Linux on CRIS architecture.
114crypto/
115 - directory with info on the Crypto API.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700116dcdbas.txt
117 - information on the Dell Systems Management Base Driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118debugging-modules.txt
119 - some notes on debugging modules after Linux 2.6.3.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700120dell_rbu.txt
121 - document demonstrating the use of the Dell Remote BIOS Update driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122device-mapper/
123 - directory with info on Device Mapper.
124devices.txt
125 - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
126digiepca.txt
127 - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700128dontdiff
129 - file containing a list of files that should never be diff'ed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130driver-model/
131 - directory with info about Linux driver model.
132dvb/
133 - info on Linux Digital Video Broadcast (DVB) subsystem.
134early-userspace/
135 - info about initramfs, klibc, and userspace early during boot.
Adrian Bunk4a6b88c2008-02-07 00:13:33 -0800136edac.txt
137 - information on EDAC - Error Detection And Correction
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138eisa.txt
139 - info on EISA bus support.
140exception.txt
141 - how Linux v2.2 handles exceptions without verify_area etc.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700142fault-injection/
143 - dir with docs about the fault injection capabilities infrastructure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144fb/
145 - directory with info on the frame buffer graphics abstraction layer.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700146feature-removal-schedule.txt
147 - list of files and features that are going to be removed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148filesystems/
J. Bruce Fields4f3b19c2007-09-24 18:52:09 -0400149 - info on the vfs and the various filesystems that Linux supports.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150firmware_class/
151 - request_firmware() hotplug interface info.
152floppy.txt
153 - notes and driver options for the floppy disk driver.
Adrian Bunk0868ff72008-02-03 15:54:28 +0200154frv/
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700155 - Fujitsu FR-V Linux documentation.
156gpio.txt
157 - overview of GPIO (General Purpose Input/Output) access conventions.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158hayes-esp.txt
159 - info on using the Hayes ESP serial driver.
160highuid.txt
161 - notes on the change from 16 bit to 32 bit user/group IDs.
Thomas Gleixner3833eec2008-03-05 18:28:15 +0100162timers/
163 - info on the timer related topics
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164hw_random.txt
165 - info on Linux support for random number generator in i8xx chipsets.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700166hwmon/
167 - directory with docs on various hardware monitoring drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168i2c/
169 - directory with info about the I2C bus/protocol (2 wire, kHz speed).
170i2o/
171 - directory with info about the Linux I2O subsystem.
172i386/
173 - directory with info about Linux on Intel 32 bit architecture.
174ia64/
175 - directory with info about Linux on Intel 64 bit architecture.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700176infiniband/
177 - directory with documents concerning Linux InfiniBand support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178initrd.txt
179 - how to use the RAM disk as an initial/temporary root filesystem.
180input/
181 - info on Linux input device support.
182io_ordering.txt
183 - info on ordering I/O writes to memory-mapped addresses.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700184ioctl/
185 - directory with documents describing various IOCTL calls.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186ioctl-number.txt
187 - how to implement and register device/driver ioctl calls.
188iostats.txt
189 - info on I/O statistics Linux kernel provides.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700190irqflags-tracing.txt
191 - how to use the irq-flags tracing feature.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192isapnp.txt
193 - info on Linux ISA Plug & Play support.
194isdn/
195 - directory with info on the Linux ISDN support, and supported cards.
196java.txt
197 - info on the in-kernel binary support for Java(tm).
198kbuild/
199 - directory with info about the kernel build process.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700200kdump/
201 - directory with mini HowTo on getting the crash dump code to work.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202kernel-doc-nano-HOWTO.txt
203 - mini HowTo on generation and location of kernel documentation files.
204kernel-docs.txt
205 - listing of various WWW + books that document kernel internals.
206kernel-parameters.txt
207 - summary listing of command line / boot prompt args for the kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700208keys-request-key.txt
209 - description of the kernel key request service.
210keys.txt
211 - description of the kernel key retention service.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212kobject.txt
213 - info of the kobject infrastructure of the Linux kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700214kprobes.txt
215 - documents the kernel probes debugging feature.
216kref.txt
217 - docs on adding reference counters (krefs) to kernel objects.
Carlos Corbachod6ff3652008-02-09 01:32:03 +0000218laptops/
219 - directory with laptop related info and laptop driver documentation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220ldm.txt
221 - a brief description of LDM (Windows Dynamic Disks).
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700222leds-class.txt
223 - documents LED handling under Linux.
224local_ops.txt
225 - semantics and behavior of local atomic operations.
226lockdep-design.txt
227 - documentation on the runtime locking correctness validator.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228logo.gif
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700229 - full colour GIF image of Linux logo (penguin - Tux).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230logo.txt
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700231 - info on creator of above logo & site to get additional images from.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232m68k/
233 - directory with info about Linux on Motorola 68k architecture.
234magic-number.txt
235 - list of magic numbers used to mark/protect kernel data structures.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236mca.txt
237 - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
238md.txt
239 - info on boot arguments for the multiple devices driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700240memory-barriers.txt
241 - info on Linux kernel memory barriers.
Rob Landley5ef43562007-10-16 23:31:25 -0700242memory-hotplug.txt
243 - Hotpluggable memory support, how to use and current status.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244memory.txt
245 - info on typical Linux memory problems.
246mips/
247 - directory with info about Linux on MIPS architecture.
248mono.txt
249 - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
250moxa-smartio
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700251 - file with info on installing/using Moxa multiport serial driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700252mutex-design.txt
253 - info on the generic mutex subsystem.
Pavel Emelyanov2868f892007-11-28 16:21:39 -0800254namespaces/
255 - directory with various information about namespaces
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256nbd.txt
257 - info on a TCP implementation of a network block device.
Paul Moore8802f612006-08-03 16:45:49 -0700258netlabel/
259 - directory with information on the NetLabel subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260networking/
261 - directory with info on various aspects of networking with Linux.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262nmi_watchdog.txt
263 - info on NMI watchdog for SMP systems.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700264nommu-mmap.txt
265 - documentation about no-mmu memory mapping support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266numastat.txt
267 - info on how to read Numa policy hit/miss statistics in sysfs.
268oops-tracing.txt
269 - how to decode those nasty internal kernel error dump messages.
270paride.txt
271 - information about the parallel port IDE subsystem.
272parisc/
273 - directory with info on using Linux on PA-RISC architecture.
274parport.txt
275 - how to use the parallel-port driver.
276parport-lowlevel.txt
277 - description and usage of the low level parallel port functions.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700278pcmcia/
279 - info on the Linux PCMCIA driver.
280pi-futex.txt
281 - documentation on lightweight PI-futexes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282pnp.txt
283 - Linux Plug and Play documentation.
284power/
285 - directory with info on Linux PCI power management.
286powerpc/
287 - directory with info on using Linux with the PowerPC.
288preempt-locking.txt
289 - info on locking under a preemptive kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700290prio_tree.txt
291 - info on radix-priority-search-tree use for indexing vmas.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292ramdisk.txt
293 - short guide on how to set up and use the RAM disk.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700294rbtree.txt
295 - info on what red-black trees are and what they are for.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296riscom8.txt
297 - notes on using the RISCom/8 multi-port serial driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700298robust-futex-ABI.txt
299 - documentation of the robust futex ABI.
300robust-futexes.txt
301 - a description of what robust futexes are.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302rocket.txt
303 - info on the Comtrol RocketPort multiport serial driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700304rt-mutex-design.txt
305 - description of the RealTime mutex implementation design.
306rt-mutex.txt
307 - desc. of RT-mutex subsystem with PI (Priority Inheritance) support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308rtc.txt
309 - notes on how to use the Real Time Clock (aka CMOS clock) driver.
310s390/
311 - directory with info on using Linux on the IBM S390.
J. Bruce Fields9b8eae72008-02-07 00:13:37 -0800312scheduler/
313 - directory with info on the scheduler.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314scsi/
315 - directory with info on Linux scsi support.
316serial/
317 - directory with info on the low level serial API.
318serial-console.txt
319 - how to set up Linux with a serial line console as the default.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700320sgi-ioc4.txt
321 - description of the SGI IOC4 PCI (multi function) device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322sgi-visws.txt
323 - short blurb on the SGI Visual Workstations.
324sh/
325 - directory with info on porting Linux to a new architecture.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326sound/
327 - directory with info on sound card support.
328sparc/
329 - directory with info on using Linux on Sparc architecture.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700330sparse.txt
331 - info on how to obtain and use the sparse tool for typechecking.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332specialix.txt
333 - info on hardware/driver for specialix IO8+ multiport serial card.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700334spi/
335 - overview of Linux kernel Serial Peripheral Interface (SPI) support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336spinlocks.txt
337 - info on using spinlocks to provide exclusive access in kernel.
Greg Kroah-Hartman8907e942005-11-18 09:31:15 -0800338stable_api_nonsense.txt
339 - info on why the kernel does not have a stable in-kernel api or abi.
340stable_kernel_rules.txt
341 - rules and procedures for the -stable kernel releases.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342stallion.txt
343 - info on using the Stallion multiport serial driver.
344svga.txt
345 - short guide on selecting video modes at boot via VGA BIOS.
Rob Landley5ef43562007-10-16 23:31:25 -0700346sysfs-rules.txt
347 - How not to use sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348sx.txt
349 - info on the Specialix SX/SI multiport serial driver.
350sysctl/
351 - directory with info on the /proc/sys/* files.
352sysrq.txt
353 - info on the magic SysRq key.
354telephony/
355 - directory with info on telephony (e.g. voice over IP) support.
356time_interpolators.txt
357 - info on time interpolators.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358tty.txt
359 - guide to the locking policies of the tty layer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360uml/
Tobias Klauserd533f672005-09-10 00:26:46 -0700361 - directory with information about User Mode Linux.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700362unicode.txt
363 - info on the Unicode character/font mapping used in Linux.
364unshare.txt
365 - description of the Linux unshare system call.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366usb/
367 - directory with info regarding the Universal Serial Bus.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700368video-output.txt
369 - sysfs class driver interface to enable/disable a video output device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370video4linux/
371 - directory with info regarding video/TV/radio cards and linux.
372vm/
373 - directory with info on the Linux vm code.
Rob Landley5ef43562007-10-16 23:31:25 -0700374volatile-considered-harmful.txt
375 - Why the "volatile" type class should not be used
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376voyager.txt
377 - guide to running Linux on the Voyager architecture.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700378w1/
379 - directory with documents regarding the 1-wire (w1) subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380watchdog/
381 - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
382x86_64/
383 - directory with info on Linux support for AMD x86-64 (Hammer) machines.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384zorro.txt
385 - info on writing drivers for Zorro bus devices found on Amigas.