blob: edef85ce1195e0a0e98f2f135d4051c1b5844947 [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.
Jonathan Corbet75b02142008-09-30 15:15:56 -060024development-process/
25 - An extended tutorial on how to work with the kernel development
26 process.
Linus Torvalds1da177e2005-04-16 15:20:36 -070027DMA-API.txt
28 - DMA API, pci_ API & extensions for non-consistent memory machines.
Rob Landley5ef43562007-10-16 23:31:25 -070029DMA-ISA-LPC.txt
30 - How to do DMA with ISA (and LPC) devices.
Linus Torvalds1da177e2005-04-16 15:20:36 -070031DocBook/
32 - directory with DocBook templates etc. for kernel documentation.
Greg Kroah-Hartmand36cc9d2005-11-18 09:31:11 -080033HOWTO
Jesper Juhlf6b07d32007-07-15 23:41:41 -070034 - the process and procedures of how to do Linux kernel development.
Linus Torvalds1da177e2005-04-16 15:20:36 -070035IO-mapping.txt
36 - how to access I/O mapped memory from within device drivers.
37IPMI.txt
38 - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
39IRQ-affinity.txt
40 - how to select which CPU(s) handle which interrupt events on SMP.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070041IRQ.txt
42 - description of what an IRQ is.
Linus Torvalds1da177e2005-04-16 15:20:36 -070043ManagementStyle
44 - how to (attempt to) manage kernel hackers.
45MSI-HOWTO.txt
46 - the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ.
47RCU/
48 - directory with info on RCU (read-copy update).
49README.DAC960
50 - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070051README.cycladesZ
52 - info on Cyclades-Z firmware loading.
Linus Torvalds1da177e2005-04-16 15:20:36 -070053SAK.txt
54 - info on Secure Attention Keys.
Rob Landley5ef43562007-10-16 23:31:25 -070055SM501.txt
56 - Silicon Motion SM501 multimedia companion chip
Jesper Juhlf6b07d32007-07-15 23:41:41 -070057SecurityBugs
58 - procedure for reporting security bugs found in the kernel.
59SubmitChecklist
60 - Linux kernel patch submission checklist.
Linus Torvalds1da177e2005-04-16 15:20:36 -070061SubmittingDrivers
62 - procedure to get a new driver source included into the kernel tree.
63SubmittingPatches
64 - procedure to get a source patch included into the kernel tree.
65VGA-softcursor.txt
66 - how to change your VGA cursor from a blinking underscore.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070067accounting/
68 - documentation on accounting and taskstats.
Len Brownb4d27302007-11-14 19:53:21 -050069acpi/
70 - info on ACPI-specific hooks in the kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070071aoe/
72 - description of AoE (ATA over Ethernet) along with config examples.
Jesper Juhl754c7972005-09-09 13:10:12 -070073applying-patches.txt
74 - description of various trees and how to apply their patches.
Linus Torvalds1da177e2005-04-16 15:20:36 -070075arm/
76 - directory with info about Linux on the ARM architecture.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070077atomic_ops.txt
78 - semantics and behavior of atomic and bitmask operations.
79auxdisplay/
80 - misc. LCD driver documentation (cfag12864b, ks0108).
Linus Torvalds1da177e2005-04-16 15:20:36 -070081basic_profiling.txt
82 - basic instructions for those who wants to profile Linux kernel.
83binfmt_misc.txt
84 - info on the kernel support for extra binary formats.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070085blackfin/
86 - directory with documentation for the Blackfin arch.
Linus Torvalds1da177e2005-04-16 15:20:36 -070087block/
88 - info on the Block I/O (BIO) layer.
89cachetlb.txt
90 - describes the cache/TLB flushing interfaces Linux uses.
91cciss.txt
92 - info, major/minor #'s for Compaq's SMART Array Controllers.
93cdrom/
94 - directory with information on the CD-ROM drivers that Linux has.
Linus Torvalds1da177e2005-04-16 15:20:36 -070095computone.txt
96 - info on Computone Intelliport II/Plus Multiport Serial Driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070097connector/
98 - docs on the netlink based userspace<->kernel space communication mod.
99console/
100 - documentation on Linux console drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101cpqarray.txt
102 - info on using Compaq's SMART2 Intelligent Disk Array Controllers.
103cpu-freq/
104 - info on CPU frequency and voltage scaling.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700105cpu-hotplug.txt
106 - document describing CPU hotplug support in the Linux kernel.
107cpu-load.txt
108 - document describing how CPU load statistics are collected.
Venkatesh Pallipadife8e2882008-02-14 00:16:13 -0500109cpuidle/
110 - info on CPU_IDLE, CPU idle state management subsystem.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700111cpusets.txt
112 - documents the cpusets feature; assign CPUs and Mem to a set of tasks.
113cputopology.txt
114 - documentation on how CPU topology info is exported via sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115cris/
116 - directory with info about Linux on CRIS architecture.
117crypto/
118 - directory with info on the Crypto API.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700119dcdbas.txt
120 - information on the Dell Systems Management Base Driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121debugging-modules.txt
122 - some notes on debugging modules after Linux 2.6.3.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700123dell_rbu.txt
124 - document demonstrating the use of the Dell Remote BIOS Update driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125device-mapper/
126 - directory with info on Device Mapper.
127devices.txt
128 - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
129digiepca.txt
130 - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700131dontdiff
132 - file containing a list of files that should never be diff'ed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133driver-model/
134 - directory with info about Linux driver model.
135dvb/
136 - info on Linux Digital Video Broadcast (DVB) subsystem.
137early-userspace/
138 - info about initramfs, klibc, and userspace early during boot.
Adrian Bunk4a6b88c2008-02-07 00:13:33 -0800139edac.txt
140 - information on EDAC - Error Detection And Correction
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141eisa.txt
142 - info on EISA bus support.
143exception.txt
144 - how Linux v2.2 handles exceptions without verify_area etc.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700145fault-injection/
146 - dir with docs about the fault injection capabilities infrastructure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147fb/
148 - directory with info on the frame buffer graphics abstraction layer.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700149feature-removal-schedule.txt
150 - list of files and features that are going to be removed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151filesystems/
J. Bruce Fields4f3b19c2007-09-24 18:52:09 -0400152 - info on the vfs and the various filesystems that Linux supports.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153firmware_class/
154 - request_firmware() hotplug interface info.
155floppy.txt
156 - notes and driver options for the floppy disk driver.
Adrian Bunk0868ff72008-02-03 15:54:28 +0200157frv/
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700158 - Fujitsu FR-V Linux documentation.
159gpio.txt
160 - overview of GPIO (General Purpose Input/Output) access conventions.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161hayes-esp.txt
162 - info on using the Hayes ESP serial driver.
163highuid.txt
164 - notes on the change from 16 bit to 32 bit user/group IDs.
Thomas Gleixner3833eec2008-03-05 18:28:15 +0100165timers/
166 - info on the timer related topics
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167hw_random.txt
168 - info on Linux support for random number generator in i8xx chipsets.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700169hwmon/
170 - directory with docs on various hardware monitoring drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171i2c/
172 - directory with info about the I2C bus/protocol (2 wire, kHz speed).
173i2o/
174 - directory with info about the Linux I2O subsystem.
Uwe Hermann71cced62008-10-20 09:32:21 -0700175x86/i386/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 - directory with info about Linux on Intel 32 bit architecture.
177ia64/
178 - directory with info about Linux on Intel 64 bit architecture.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700179infiniband/
180 - directory with documents concerning Linux InfiniBand support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181initrd.txt
182 - how to use the RAM disk as an initial/temporary root filesystem.
183input/
184 - info on Linux input device support.
185io_ordering.txt
186 - info on ordering I/O writes to memory-mapped addresses.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700187ioctl/
188 - directory with documents describing various IOCTL calls.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189ioctl-number.txt
190 - how to implement and register device/driver ioctl calls.
191iostats.txt
192 - info on I/O statistics Linux kernel provides.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700193irqflags-tracing.txt
194 - how to use the irq-flags tracing feature.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195isapnp.txt
196 - info on Linux ISA Plug & Play support.
197isdn/
198 - directory with info on the Linux ISDN support, and supported cards.
199java.txt
200 - info on the in-kernel binary support for Java(tm).
201kbuild/
202 - directory with info about the kernel build process.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700203kdump/
204 - directory with mini HowTo on getting the crash dump code to work.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205kernel-doc-nano-HOWTO.txt
206 - mini HowTo on generation and location of kernel documentation files.
207kernel-docs.txt
208 - listing of various WWW + books that document kernel internals.
209kernel-parameters.txt
210 - summary listing of command line / boot prompt args for the kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700211keys-request-key.txt
212 - description of the kernel key request service.
213keys.txt
214 - description of the kernel key retention service.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215kobject.txt
216 - info of the kobject infrastructure of the Linux kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700217kprobes.txt
218 - documents the kernel probes debugging feature.
219kref.txt
220 - docs on adding reference counters (krefs) to kernel objects.
Carlos Corbachod6ff3652008-02-09 01:32:03 +0000221laptops/
222 - directory with laptop related info and laptop driver documentation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223ldm.txt
224 - a brief description of LDM (Windows Dynamic Disks).
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700225leds-class.txt
226 - documents LED handling under Linux.
227local_ops.txt
228 - semantics and behavior of local atomic operations.
229lockdep-design.txt
230 - documentation on the runtime locking correctness validator.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231logo.gif
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700232 - full colour GIF image of Linux logo (penguin - Tux).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233logo.txt
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700234 - info on creator of above logo & site to get additional images from.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235m68k/
236 - directory with info about Linux on Motorola 68k architecture.
237magic-number.txt
238 - list of magic numbers used to mark/protect kernel data structures.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239mca.txt
240 - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
241md.txt
242 - info on boot arguments for the multiple devices driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700243memory-barriers.txt
244 - info on Linux kernel memory barriers.
Rob Landley5ef43562007-10-16 23:31:25 -0700245memory-hotplug.txt
246 - Hotpluggable memory support, how to use and current status.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247memory.txt
248 - info on typical Linux memory problems.
249mips/
250 - directory with info about Linux on MIPS architecture.
251mono.txt
252 - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
253moxa-smartio
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700254 - file with info on installing/using Moxa multiport serial driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700255mutex-design.txt
256 - info on the generic mutex subsystem.
Pavel Emelyanov2868f892007-11-28 16:21:39 -0800257namespaces/
258 - directory with various information about namespaces
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259nbd.txt
260 - info on a TCP implementation of a network block device.
Paul Moore8802f612006-08-03 16:45:49 -0700261netlabel/
262 - directory with information on the NetLabel subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263networking/
264 - directory with info on various aspects of networking with Linux.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265nmi_watchdog.txt
266 - info on NMI watchdog for SMP systems.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700267nommu-mmap.txt
268 - documentation about no-mmu memory mapping support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269numastat.txt
270 - info on how to read Numa policy hit/miss statistics in sysfs.
271oops-tracing.txt
272 - how to decode those nasty internal kernel error dump messages.
273paride.txt
274 - information about the parallel port IDE subsystem.
275parisc/
276 - directory with info on using Linux on PA-RISC architecture.
277parport.txt
278 - how to use the parallel-port driver.
279parport-lowlevel.txt
280 - description and usage of the low level parallel port functions.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700281pcmcia/
282 - info on the Linux PCMCIA driver.
283pi-futex.txt
284 - documentation on lightweight PI-futexes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285pnp.txt
286 - Linux Plug and Play documentation.
287power/
288 - directory with info on Linux PCI power management.
289powerpc/
290 - directory with info on using Linux with the PowerPC.
291preempt-locking.txt
292 - info on locking under a preemptive kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700293prio_tree.txt
294 - info on radix-priority-search-tree use for indexing vmas.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295ramdisk.txt
296 - short guide on how to set up and use the RAM disk.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700297rbtree.txt
298 - info on what red-black trees are and what they are for.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299riscom8.txt
300 - notes on using the RISCom/8 multi-port serial driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700301robust-futex-ABI.txt
302 - documentation of the robust futex ABI.
303robust-futexes.txt
304 - a description of what robust futexes are.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305rocket.txt
306 - info on the Comtrol RocketPort multiport serial driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700307rt-mutex-design.txt
308 - description of the RealTime mutex implementation design.
309rt-mutex.txt
310 - desc. of RT-mutex subsystem with PI (Priority Inheritance) support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311rtc.txt
312 - notes on how to use the Real Time Clock (aka CMOS clock) driver.
313s390/
314 - directory with info on using Linux on the IBM S390.
J. Bruce Fields9b8eae72008-02-07 00:13:37 -0800315scheduler/
316 - directory with info on the scheduler.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317scsi/
318 - directory with info on Linux scsi support.
319serial/
320 - directory with info on the low level serial API.
321serial-console.txt
322 - how to set up Linux with a serial line console as the default.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700323sgi-ioc4.txt
324 - description of the SGI IOC4 PCI (multi function) device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325sgi-visws.txt
326 - short blurb on the SGI Visual Workstations.
327sh/
328 - directory with info on porting Linux to a new architecture.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329sound/
330 - directory with info on sound card support.
331sparc/
332 - directory with info on using Linux on Sparc architecture.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700333sparse.txt
334 - info on how to obtain and use the sparse tool for typechecking.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335specialix.txt
336 - info on hardware/driver for specialix IO8+ multiport serial card.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700337spi/
338 - overview of Linux kernel Serial Peripheral Interface (SPI) support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339spinlocks.txt
340 - info on using spinlocks to provide exclusive access in kernel.
Greg Kroah-Hartman8907e942005-11-18 09:31:15 -0800341stable_api_nonsense.txt
342 - info on why the kernel does not have a stable in-kernel api or abi.
343stable_kernel_rules.txt
344 - rules and procedures for the -stable kernel releases.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345stallion.txt
346 - info on using the Stallion multiport serial driver.
347svga.txt
348 - short guide on selecting video modes at boot via VGA BIOS.
Rob Landley5ef43562007-10-16 23:31:25 -0700349sysfs-rules.txt
350 - How not to use sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351sx.txt
352 - info on the Specialix SX/SI multiport serial driver.
353sysctl/
354 - directory with info on the /proc/sys/* files.
355sysrq.txt
356 - info on the magic SysRq key.
357telephony/
358 - directory with info on telephony (e.g. voice over IP) support.
359time_interpolators.txt
360 - info on time interpolators.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361tty.txt
362 - guide to the locking policies of the tty layer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363uml/
Tobias Klauserd533f672005-09-10 00:26:46 -0700364 - directory with information about User Mode Linux.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700365unicode.txt
366 - info on the Unicode character/font mapping used in Linux.
367unshare.txt
368 - description of the Linux unshare system call.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369usb/
370 - directory with info regarding the Universal Serial Bus.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700371video-output.txt
372 - sysfs class driver interface to enable/disable a video output device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373video4linux/
374 - directory with info regarding video/TV/radio cards and linux.
375vm/
376 - directory with info on the Linux vm code.
Rob Landley5ef43562007-10-16 23:31:25 -0700377volatile-considered-harmful.txt
378 - Why the "volatile" type class should not be used
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379voyager.txt
380 - guide to running Linux on the Voyager architecture.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700381w1/
382 - directory with documents regarding the 1-wire (w1) subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383watchdog/
384 - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
Uwe Hermann71cced62008-10-20 09:32:21 -0700385x86/x86_64/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386 - directory with info on Linux support for AMD x86-64 (Hammer) machines.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387zorro.txt
388 - info on writing drivers for Zorro bus devices found on Amigas.