blob: 1977fab386566e23f501bea233f8f487d16f5c38 [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.
92cli-sti-removal.txt
93 - cli()/sti() removal guide.
94computone.txt
95 - info on Computone Intelliport II/Plus Multiport Serial Driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070096connector/
97 - docs on the netlink based userspace<->kernel space communication mod.
98console/
99 - documentation on Linux console drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100cpqarray.txt
101 - info on using Compaq's SMART2 Intelligent Disk Array Controllers.
102cpu-freq/
103 - info on CPU frequency and voltage scaling.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700104cpu-hotplug.txt
105 - document describing CPU hotplug support in the Linux kernel.
106cpu-load.txt
107 - document describing how CPU load statistics are collected.
Venkatesh Pallipadife8e2882008-02-14 00:16:13 -0500108cpuidle/
109 - info on CPU_IDLE, CPU idle state management subsystem.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700110cpusets.txt
111 - documents the cpusets feature; assign CPUs and Mem to a set of tasks.
112cputopology.txt
113 - documentation on how CPU topology info is exported via sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114cris/
115 - directory with info about Linux on CRIS architecture.
116crypto/
117 - directory with info on the Crypto API.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700118dcdbas.txt
119 - information on the Dell Systems Management Base Driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120debugging-modules.txt
121 - some notes on debugging modules after Linux 2.6.3.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700122dell_rbu.txt
123 - document demonstrating the use of the Dell Remote BIOS Update driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124device-mapper/
125 - directory with info on Device Mapper.
126devices.txt
127 - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
128digiepca.txt
129 - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700130dontdiff
131 - file containing a list of files that should never be diff'ed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132driver-model/
133 - directory with info about Linux driver model.
134dvb/
135 - info on Linux Digital Video Broadcast (DVB) subsystem.
136early-userspace/
137 - info about initramfs, klibc, and userspace early during boot.
Adrian Bunk4a6b88c2008-02-07 00:13:33 -0800138edac.txt
139 - information on EDAC - Error Detection And Correction
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140eisa.txt
141 - info on EISA bus support.
142exception.txt
143 - how Linux v2.2 handles exceptions without verify_area etc.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700144fault-injection/
145 - dir with docs about the fault injection capabilities infrastructure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146fb/
147 - directory with info on the frame buffer graphics abstraction layer.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700148feature-removal-schedule.txt
149 - list of files and features that are going to be removed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150filesystems/
J. Bruce Fields4f3b19c2007-09-24 18:52:09 -0400151 - info on the vfs and the various filesystems that Linux supports.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152firmware_class/
153 - request_firmware() hotplug interface info.
154floppy.txt
155 - notes and driver options for the floppy disk driver.
Adrian Bunk0868ff72008-02-03 15:54:28 +0200156frv/
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700157 - Fujitsu FR-V Linux documentation.
158gpio.txt
159 - overview of GPIO (General Purpose Input/Output) access conventions.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160hayes-esp.txt
161 - info on using the Hayes ESP serial driver.
162highuid.txt
163 - notes on the change from 16 bit to 32 bit user/group IDs.
164hpet.txt
165 - High Precision Event Timer Driver for Linux.
Thomas Gleixner3833eec2008-03-05 18:28:15 +0100166timers/
167 - info on the timer related topics
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168hw_random.txt
169 - info on Linux support for random number generator in i8xx chipsets.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700170hwmon/
171 - directory with docs on various hardware monitoring drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172i2c/
173 - directory with info about the I2C bus/protocol (2 wire, kHz speed).
174i2o/
175 - directory with info about the Linux I2O subsystem.
176i386/
177 - directory with info about Linux on Intel 32 bit architecture.
178ia64/
179 - directory with info about Linux on Intel 64 bit architecture.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700180infiniband/
181 - directory with documents concerning Linux InfiniBand support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182initrd.txt
183 - how to use the RAM disk as an initial/temporary root filesystem.
184input/
185 - info on Linux input device support.
186io_ordering.txt
187 - info on ordering I/O writes to memory-mapped addresses.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700188ioctl/
189 - directory with documents describing various IOCTL calls.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190ioctl-number.txt
191 - how to implement and register device/driver ioctl calls.
192iostats.txt
193 - info on I/O statistics Linux kernel provides.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700194irqflags-tracing.txt
195 - how to use the irq-flags tracing feature.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196isapnp.txt
197 - info on Linux ISA Plug & Play support.
198isdn/
199 - directory with info on the Linux ISDN support, and supported cards.
200java.txt
201 - info on the in-kernel binary support for Java(tm).
202kbuild/
203 - directory with info about the kernel build process.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700204kdump/
205 - directory with mini HowTo on getting the crash dump code to work.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206kernel-doc-nano-HOWTO.txt
207 - mini HowTo on generation and location of kernel documentation files.
208kernel-docs.txt
209 - listing of various WWW + books that document kernel internals.
210kernel-parameters.txt
211 - summary listing of command line / boot prompt args for the kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700212keys-request-key.txt
213 - description of the kernel key request service.
214keys.txt
215 - description of the kernel key retention service.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216kobject.txt
217 - info of the kobject infrastructure of the Linux kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700218kprobes.txt
219 - documents the kernel probes debugging feature.
220kref.txt
221 - docs on adding reference counters (krefs) to kernel objects.
Carlos Corbachod6ff3652008-02-09 01:32:03 +0000222laptops/
223 - directory with laptop related info and laptop driver documentation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224ldm.txt
225 - a brief description of LDM (Windows Dynamic Disks).
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700226leds-class.txt
227 - documents LED handling under Linux.
228local_ops.txt
229 - semantics and behavior of local atomic operations.
230lockdep-design.txt
231 - documentation on the runtime locking correctness validator.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232logo.gif
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700233 - full colour GIF image of Linux logo (penguin - Tux).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234logo.txt
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700235 - info on creator of above logo & site to get additional images from.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236m68k/
237 - directory with info about Linux on Motorola 68k architecture.
238magic-number.txt
239 - list of magic numbers used to mark/protect kernel data structures.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240mca.txt
241 - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
242md.txt
243 - info on boot arguments for the multiple devices driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700244memory-barriers.txt
245 - info on Linux kernel memory barriers.
Rob Landley5ef43562007-10-16 23:31:25 -0700246memory-hotplug.txt
247 - Hotpluggable memory support, how to use and current status.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248memory.txt
249 - info on typical Linux memory problems.
250mips/
251 - directory with info about Linux on MIPS architecture.
252mono.txt
253 - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
254moxa-smartio
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700255 - file with info on installing/using Moxa multiport serial driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256mtrr.txt
257 - how to use PPro Memory Type Range Registers to increase performance.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700258mutex-design.txt
259 - info on the generic mutex subsystem.
Pavel Emelyanov2868f892007-11-28 16:21:39 -0800260namespaces/
261 - directory with various information about namespaces
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262nbd.txt
263 - info on a TCP implementation of a network block device.
Paul Moore8802f612006-08-03 16:45:49 -0700264netlabel/
265 - directory with information on the NetLabel subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266networking/
267 - directory with info on various aspects of networking with Linux.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268nmi_watchdog.txt
269 - info on NMI watchdog for SMP systems.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700270nommu-mmap.txt
271 - documentation about no-mmu memory mapping support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272numastat.txt
273 - info on how to read Numa policy hit/miss statistics in sysfs.
274oops-tracing.txt
275 - how to decode those nasty internal kernel error dump messages.
276paride.txt
277 - information about the parallel port IDE subsystem.
278parisc/
279 - directory with info on using Linux on PA-RISC architecture.
280parport.txt
281 - how to use the parallel-port driver.
282parport-lowlevel.txt
283 - description and usage of the low level parallel port functions.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700284pcmcia/
285 - info on the Linux PCMCIA driver.
286pi-futex.txt
287 - documentation on lightweight PI-futexes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288pnp.txt
289 - Linux Plug and Play documentation.
290power/
291 - directory with info on Linux PCI power management.
292powerpc/
293 - directory with info on using Linux with the PowerPC.
294preempt-locking.txt
295 - info on locking under a preemptive kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700296prio_tree.txt
297 - info on radix-priority-search-tree use for indexing vmas.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298ramdisk.txt
299 - short guide on how to set up and use the RAM disk.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700300rbtree.txt
301 - info on what red-black trees are and what they are for.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302riscom8.txt
303 - notes on using the RISCom/8 multi-port serial driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700304robust-futex-ABI.txt
305 - documentation of the robust futex ABI.
306robust-futexes.txt
307 - a description of what robust futexes are.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308rocket.txt
309 - info on the Comtrol RocketPort multiport serial driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700310rt-mutex-design.txt
311 - description of the RealTime mutex implementation design.
312rt-mutex.txt
313 - desc. of RT-mutex subsystem with PI (Priority Inheritance) support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314rtc.txt
315 - notes on how to use the Real Time Clock (aka CMOS clock) driver.
316s390/
317 - directory with info on using Linux on the IBM S390.
J. Bruce Fields9b8eae72008-02-07 00:13:37 -0800318scheduler/
319 - directory with info on the scheduler.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320scsi/
321 - directory with info on Linux scsi support.
322serial/
323 - directory with info on the low level serial API.
324serial-console.txt
325 - how to set up Linux with a serial line console as the default.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700326sgi-ioc4.txt
327 - description of the SGI IOC4 PCI (multi function) device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328sgi-visws.txt
329 - short blurb on the SGI Visual Workstations.
330sh/
331 - directory with info on porting Linux to a new architecture.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332sound/
333 - directory with info on sound card support.
334sparc/
335 - directory with info on using Linux on Sparc architecture.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700336sparse.txt
337 - info on how to obtain and use the sparse tool for typechecking.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338specialix.txt
339 - info on hardware/driver for specialix IO8+ multiport serial card.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700340spi/
341 - overview of Linux kernel Serial Peripheral Interface (SPI) support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342spinlocks.txt
343 - info on using spinlocks to provide exclusive access in kernel.
Greg Kroah-Hartman8907e942005-11-18 09:31:15 -0800344stable_api_nonsense.txt
345 - info on why the kernel does not have a stable in-kernel api or abi.
346stable_kernel_rules.txt
347 - rules and procedures for the -stable kernel releases.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348stallion.txt
349 - info on using the Stallion multiport serial driver.
350svga.txt
351 - short guide on selecting video modes at boot via VGA BIOS.
Rob Landley5ef43562007-10-16 23:31:25 -0700352sysfs-rules.txt
353 - How not to use sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354sx.txt
355 - info on the Specialix SX/SI multiport serial driver.
356sysctl/
357 - directory with info on the /proc/sys/* files.
358sysrq.txt
359 - info on the magic SysRq key.
360telephony/
361 - directory with info on telephony (e.g. voice over IP) support.
362time_interpolators.txt
363 - info on time interpolators.
364tipar.txt
365 - information about Parallel link cable for Texas Instruments handhelds.
366tty.txt
367 - guide to the locking policies of the tty layer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368uml/
Tobias Klauserd533f672005-09-10 00:26:46 -0700369 - directory with information about User Mode Linux.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700370unicode.txt
371 - info on the Unicode character/font mapping used in Linux.
372unshare.txt
373 - description of the Linux unshare system call.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374usb/
375 - directory with info regarding the Universal Serial Bus.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700376video-output.txt
377 - sysfs class driver interface to enable/disable a video output device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378video4linux/
379 - directory with info regarding video/TV/radio cards and linux.
380vm/
381 - directory with info on the Linux vm code.
Rob Landley5ef43562007-10-16 23:31:25 -0700382volatile-considered-harmful.txt
383 - Why the "volatile" type class should not be used
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384voyager.txt
385 - guide to running Linux on the Voyager architecture.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700386w1/
387 - directory with documents regarding the 1-wire (w1) subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388watchdog/
389 - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
390x86_64/
391 - directory with info on Linux support for AMD x86-64 (Hammer) machines.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392zorro.txt
393 - info on writing drivers for Zorro bus devices found on Amigas.