blob: 30b327a116eaa8d15af97c3047ab2c07ebc41089 [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 -070028DMA-mapping.txt
29 - info for PCI drivers using DMA portably across all platforms.
30DocBook/
31 - directory with DocBook templates etc. for kernel documentation.
Greg Kroah-Hartmand36cc9d2005-11-18 09:31:11 -080032HOWTO
Jesper Juhlf6b07d32007-07-15 23:41:41 -070033 - the process and procedures of how to do Linux kernel development.
Linus Torvalds1da177e2005-04-16 15:20:36 -070034IO-mapping.txt
35 - how to access I/O mapped memory from within device drivers.
36IPMI.txt
37 - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
38IRQ-affinity.txt
39 - how to select which CPU(s) handle which interrupt events on SMP.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070040IRQ.txt
41 - description of what an IRQ is.
Linus Torvalds1da177e2005-04-16 15:20:36 -070042ManagementStyle
43 - how to (attempt to) manage kernel hackers.
44MSI-HOWTO.txt
45 - the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070046PCIEBUS-HOWTO.txt
47 - a guide describing the PCI Express Port Bus driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -070048RCU/
49 - directory with info on RCU (read-copy update).
50README.DAC960
51 - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070052README.cycladesZ
53 - info on Cyclades-Z firmware loading.
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.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070078atomic_ops.txt
79 - semantics and behavior of atomic and bitmask operations.
80auxdisplay/
81 - misc. LCD driver documentation (cfag12864b, ks0108).
Linus Torvalds1da177e2005-04-16 15:20:36 -070082basic_profiling.txt
83 - basic instructions for those who wants to profile Linux kernel.
84binfmt_misc.txt
85 - info on the kernel support for extra binary formats.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070086blackfin/
87 - directory with documentation for the Blackfin arch.
Linus Torvalds1da177e2005-04-16 15:20:36 -070088block/
89 - info on the Block I/O (BIO) layer.
90cachetlb.txt
91 - describes the cache/TLB flushing interfaces Linux uses.
92cciss.txt
93 - info, major/minor #'s for Compaq's SMART Array Controllers.
94cdrom/
95 - directory with information on the CD-ROM drivers that Linux has.
96cli-sti-removal.txt
97 - cli()/sti() removal guide.
98computone.txt
99 - info on Computone Intelliport II/Plus Multiport Serial Driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700100connector/
101 - docs on the netlink based userspace<->kernel space communication mod.
102console/
103 - documentation on Linux console drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104cpqarray.txt
105 - info on using Compaq's SMART2 Intelligent Disk Array Controllers.
106cpu-freq/
107 - info on CPU frequency and voltage scaling.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700108cpu-hotplug.txt
109 - document describing CPU hotplug support in the Linux kernel.
110cpu-load.txt
111 - document describing how CPU load statistics are collected.
Venkatesh Pallipadife8e2882008-02-14 00:16:13 -0500112cpuidle/
113 - info on CPU_IDLE, CPU idle state management subsystem.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700114cpusets.txt
115 - documents the cpusets feature; assign CPUs and Mem to a set of tasks.
116cputopology.txt
117 - documentation on how CPU topology info is exported via sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118cris/
119 - directory with info about Linux on CRIS architecture.
120crypto/
121 - directory with info on the Crypto API.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700122dcdbas.txt
123 - information on the Dell Systems Management Base Driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124debugging-modules.txt
125 - some notes on debugging modules after Linux 2.6.3.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700126dell_rbu.txt
127 - document demonstrating the use of the Dell Remote BIOS Update driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128device-mapper/
129 - directory with info on Device Mapper.
130devices.txt
131 - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
132digiepca.txt
133 - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700134dontdiff
135 - file containing a list of files that should never be diff'ed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136driver-model/
137 - directory with info about Linux driver model.
138dvb/
139 - info on Linux Digital Video Broadcast (DVB) subsystem.
140early-userspace/
141 - info about initramfs, klibc, and userspace early during boot.
Adrian Bunk4a6b88c2008-02-07 00:13:33 -0800142edac.txt
143 - information on EDAC - Error Detection And Correction
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144eisa.txt
145 - info on EISA bus support.
146exception.txt
147 - how Linux v2.2 handles exceptions without verify_area etc.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700148fault-injection/
149 - dir with docs about the fault injection capabilities infrastructure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150fb/
151 - directory with info on the frame buffer graphics abstraction layer.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700152feature-removal-schedule.txt
153 - list of files and features that are going to be removed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154filesystems/
J. Bruce Fields4f3b19c2007-09-24 18:52:09 -0400155 - info on the vfs and the various filesystems that Linux supports.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156firmware_class/
157 - request_firmware() hotplug interface info.
158floppy.txt
159 - notes and driver options for the floppy disk driver.
Adrian Bunk0868ff72008-02-03 15:54:28 +0200160frv/
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700161 - Fujitsu FR-V Linux documentation.
162gpio.txt
163 - overview of GPIO (General Purpose Input/Output) access conventions.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164hayes-esp.txt
165 - info on using the Hayes ESP serial driver.
166highuid.txt
167 - notes on the change from 16 bit to 32 bit user/group IDs.
168hpet.txt
169 - High Precision Event Timer Driver for Linux.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700170hrtimer/
171 - info on the timer_stats debugging facility for timer (ab)use.
172hrtimers/
173 - info on the hrtimers subsystem for high-resolution kernel timers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174hw_random.txt
175 - info on Linux support for random number generator in i8xx chipsets.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700176hwmon/
177 - directory with docs on various hardware monitoring drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178i2c/
179 - directory with info about the I2C bus/protocol (2 wire, kHz speed).
180i2o/
181 - directory with info about the Linux I2O subsystem.
182i386/
183 - directory with info about Linux on Intel 32 bit architecture.
184ia64/
185 - directory with info about Linux on Intel 64 bit architecture.
186ide.txt
187 - important info for users of ATA devices (IDE/EIDE disks and CD-ROMS).
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700188infiniband/
189 - directory with documents concerning Linux InfiniBand support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190initrd.txt
191 - how to use the RAM disk as an initial/temporary root filesystem.
192input/
193 - info on Linux input device support.
194io_ordering.txt
195 - info on ordering I/O writes to memory-mapped addresses.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700196ioctl/
197 - directory with documents describing various IOCTL calls.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198ioctl-number.txt
199 - how to implement and register device/driver ioctl calls.
200iostats.txt
201 - info on I/O statistics Linux kernel provides.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700202irqflags-tracing.txt
203 - how to use the irq-flags tracing feature.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204isapnp.txt
205 - info on Linux ISA Plug & Play support.
206isdn/
207 - directory with info on the Linux ISDN support, and supported cards.
208java.txt
209 - info on the in-kernel binary support for Java(tm).
210kbuild/
211 - directory with info about the kernel build process.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700212kdump/
213 - directory with mini HowTo on getting the crash dump code to work.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214kernel-doc-nano-HOWTO.txt
215 - mini HowTo on generation and location of kernel documentation files.
216kernel-docs.txt
217 - listing of various WWW + books that document kernel internals.
218kernel-parameters.txt
219 - summary listing of command line / boot prompt args for the kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700220keys-request-key.txt
221 - description of the kernel key request service.
222keys.txt
223 - description of the kernel key retention service.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224kobject.txt
225 - info of the kobject infrastructure of the Linux kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700226kprobes.txt
227 - documents the kernel probes debugging feature.
228kref.txt
229 - docs on adding reference counters (krefs) to kernel objects.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230laptop-mode.txt
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700231 - how to conserve battery power using laptop-mode.
Carlos Corbachod6ff3652008-02-09 01:32:03 +0000232laptops/
233 - directory with laptop related info and laptop driver documentation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234ldm.txt
235 - a brief description of LDM (Windows Dynamic Disks).
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700236leds-class.txt
237 - documents LED handling under Linux.
238local_ops.txt
239 - semantics and behavior of local atomic operations.
240lockdep-design.txt
241 - documentation on the runtime locking correctness validator.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242logo.gif
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700243 - full colour GIF image of Linux logo (penguin - Tux).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244logo.txt
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700245 - info on creator of above logo & site to get additional images from.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246m68k/
247 - directory with info about Linux on Motorola 68k architecture.
248magic-number.txt
249 - list of magic numbers used to mark/protect kernel data structures.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250mca.txt
251 - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
252md.txt
253 - info on boot arguments for the multiple devices driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700254memory-barriers.txt
255 - info on Linux kernel memory barriers.
Rob Landley5ef43562007-10-16 23:31:25 -0700256memory-hotplug.txt
257 - Hotpluggable memory support, how to use and current status.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258memory.txt
259 - info on typical Linux memory problems.
260mips/
261 - directory with info about Linux on MIPS architecture.
262mono.txt
263 - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
264moxa-smartio
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700265 - file with info on installing/using Moxa multiport serial driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266mtrr.txt
267 - how to use PPro Memory Type Range Registers to increase performance.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700268mutex-design.txt
269 - info on the generic mutex subsystem.
Pavel Emelyanov2868f892007-11-28 16:21:39 -0800270namespaces/
271 - directory with various information about namespaces
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272nbd.txt
273 - info on a TCP implementation of a network block device.
Paul Moore8802f612006-08-03 16:45:49 -0700274netlabel/
275 - directory with information on the NetLabel subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276networking/
277 - directory with info on various aspects of networking with Linux.
278nfsroot.txt
279 - short guide on setting up a diskless box with NFS root filesystem.
280nmi_watchdog.txt
281 - info on NMI watchdog for SMP systems.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700282nommu-mmap.txt
283 - documentation about no-mmu memory mapping support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284numastat.txt
285 - info on how to read Numa policy hit/miss statistics in sysfs.
286oops-tracing.txt
287 - how to decode those nasty internal kernel error dump messages.
288paride.txt
289 - information about the parallel port IDE subsystem.
290parisc/
291 - directory with info on using Linux on PA-RISC architecture.
292parport.txt
293 - how to use the parallel-port driver.
294parport-lowlevel.txt
295 - description and usage of the low level parallel port functions.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700296pci-error-recovery.txt
297 - info on PCI error recovery.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298pci.txt
299 - info on the PCI subsystem for device driver authors.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700300pcieaer-howto.txt
301 - the PCI Express Advanced Error Reporting Driver Guide HOWTO.
302pcmcia/
303 - info on the Linux PCMCIA driver.
304pi-futex.txt
305 - documentation on lightweight PI-futexes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306pm.txt
307 - info on Linux power management support.
308pnp.txt
309 - Linux Plug and Play documentation.
Rob Landley5ef43562007-10-16 23:31:25 -0700310power_supply_class.txt
311 - Tells userspace about battery, UPS, AC or DC power supply properties
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312power/
313 - directory with info on Linux PCI power management.
314powerpc/
315 - directory with info on using Linux with the PowerPC.
316preempt-locking.txt
317 - info on locking under a preemptive kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700318prio_tree.txt
319 - info on radix-priority-search-tree use for indexing vmas.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320ramdisk.txt
321 - short guide on how to set up and use the RAM disk.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700322rbtree.txt
323 - info on what red-black trees are and what they are for.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324riscom8.txt
325 - notes on using the RISCom/8 multi-port serial driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700326robust-futex-ABI.txt
327 - documentation of the robust futex ABI.
328robust-futexes.txt
329 - a description of what robust futexes are.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330rocket.txt
331 - info on the Comtrol RocketPort multiport serial driver.
332rpc-cache.txt
333 - introduction to the caching mechanisms in the sunrpc layer.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700334rt-mutex-design.txt
335 - description of the RealTime mutex implementation design.
336rt-mutex.txt
337 - desc. of RT-mutex subsystem with PI (Priority Inheritance) support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338rtc.txt
339 - notes on how to use the Real Time Clock (aka CMOS clock) driver.
340s390/
341 - directory with info on using Linux on the IBM S390.
J. Bruce Fields9b8eae72008-02-07 00:13:37 -0800342scheduler/
343 - directory with info on the scheduler.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344scsi/
345 - directory with info on Linux scsi support.
346serial/
347 - directory with info on the low level serial API.
348serial-console.txt
349 - how to set up Linux with a serial line console as the default.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700350sgi-ioc4.txt
351 - description of the SGI IOC4 PCI (multi function) device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352sgi-visws.txt
353 - short blurb on the SGI Visual Workstations.
354sh/
355 - directory with info on porting Linux to a new architecture.
356smart-config.txt
357 - description of the Smart Config makefile feature.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358sound/
359 - directory with info on sound card support.
360sparc/
361 - directory with info on using Linux on Sparc architecture.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700362sparse.txt
363 - info on how to obtain and use the sparse tool for typechecking.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364specialix.txt
365 - info on hardware/driver for specialix IO8+ multiport serial card.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700366spi/
367 - overview of Linux kernel Serial Peripheral Interface (SPI) support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368spinlocks.txt
369 - info on using spinlocks to provide exclusive access in kernel.
Greg Kroah-Hartman8907e942005-11-18 09:31:15 -0800370stable_api_nonsense.txt
371 - info on why the kernel does not have a stable in-kernel api or abi.
372stable_kernel_rules.txt
373 - rules and procedures for the -stable kernel releases.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374stallion.txt
375 - info on using the Stallion multiport serial driver.
376svga.txt
377 - short guide on selecting video modes at boot via VGA BIOS.
Rob Landley5ef43562007-10-16 23:31:25 -0700378sysfs-rules.txt
379 - How not to use sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380sx.txt
381 - info on the Specialix SX/SI multiport serial driver.
382sysctl/
383 - directory with info on the /proc/sys/* files.
384sysrq.txt
385 - info on the magic SysRq key.
386telephony/
387 - directory with info on telephony (e.g. voice over IP) support.
388time_interpolators.txt
389 - info on time interpolators.
390tipar.txt
391 - information about Parallel link cable for Texas Instruments handhelds.
392tty.txt
393 - guide to the locking policies of the tty layer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394uml/
Tobias Klauserd533f672005-09-10 00:26:46 -0700395 - directory with information about User Mode Linux.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700396unicode.txt
397 - info on the Unicode character/font mapping used in Linux.
398unshare.txt
399 - description of the Linux unshare system call.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400usb/
401 - directory with info regarding the Universal Serial Bus.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700402video-output.txt
403 - sysfs class driver interface to enable/disable a video output device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404video4linux/
405 - directory with info regarding video/TV/radio cards and linux.
406vm/
407 - directory with info on the Linux vm code.
Rob Landley5ef43562007-10-16 23:31:25 -0700408volatile-considered-harmful.txt
409 - Why the "volatile" type class should not be used
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410voyager.txt
411 - guide to running Linux on the Voyager architecture.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700412w1/
413 - directory with documents regarding the 1-wire (w1) subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414watchdog/
415 - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
416x86_64/
417 - directory with info on Linux support for AMD x86-64 (Hammer) machines.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418zorro.txt
419 - info on writing drivers for Zorro bus devices found on Amigas.