blob: 43e89b1537d9b251524f3b09002f02b03fc4ae15 [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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070017BUG-HUNTING
18 - brute force method of doing binary search of patches to find bug.
19Changes
20 - list of changes that break older software packages.
21CodingStyle
22 - how the boss likes the C code in the kernel to look.
23DMA-API.txt
24 - DMA API, pci_ API & extensions for non-consistent memory machines.
25DMA-mapping.txt
26 - info for PCI drivers using DMA portably across all platforms.
27DocBook/
28 - directory with DocBook templates etc. for kernel documentation.
Greg Kroah-Hartmand36cc9d2005-11-18 09:31:11 -080029HOWTO
Jesper Juhlf6b07d32007-07-15 23:41:41 -070030 - the process and procedures of how to do Linux kernel development.
Linus Torvalds1da177e2005-04-16 15:20:36 -070031IO-mapping.txt
32 - how to access I/O mapped memory from within device drivers.
33IPMI.txt
34 - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
35IRQ-affinity.txt
36 - how to select which CPU(s) handle which interrupt events on SMP.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070037IRQ.txt
38 - description of what an IRQ is.
Linus Torvalds1da177e2005-04-16 15:20:36 -070039ManagementStyle
40 - how to (attempt to) manage kernel hackers.
41MSI-HOWTO.txt
42 - the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070043PCIEBUS-HOWTO.txt
44 - a guide describing the PCI Express Port Bus driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -070045RCU/
46 - directory with info on RCU (read-copy update).
47README.DAC960
48 - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070049README.cycladesZ
50 - info on Cyclades-Z firmware loading.
Linus Torvalds1da177e2005-04-16 15:20:36 -070051SAK.txt
52 - info on Secure Attention Keys.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070053SecurityBugs
54 - procedure for reporting security bugs found in the kernel.
55SubmitChecklist
56 - Linux kernel patch submission checklist.
Linus Torvalds1da177e2005-04-16 15:20:36 -070057SubmittingDrivers
58 - procedure to get a new driver source included into the kernel tree.
59SubmittingPatches
60 - procedure to get a source patch included into the kernel tree.
61VGA-softcursor.txt
62 - how to change your VGA cursor from a blinking underscore.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070063accounting/
64 - documentation on accounting and taskstats.
65aoe/
66 - description of AoE (ATA over Ethernet) along with config examples.
Jesper Juhl754c7972005-09-09 13:10:12 -070067applying-patches.txt
68 - description of various trees and how to apply their patches.
Linus Torvalds1da177e2005-04-16 15:20:36 -070069arm/
70 - directory with info about Linux on the ARM architecture.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070071atomic_ops.txt
72 - semantics and behavior of atomic and bitmask operations.
73auxdisplay/
74 - misc. LCD driver documentation (cfag12864b, ks0108).
Linus Torvalds1da177e2005-04-16 15:20:36 -070075basic_profiling.txt
76 - basic instructions for those who wants to profile Linux kernel.
77binfmt_misc.txt
78 - info on the kernel support for extra binary formats.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070079blackfin/
80 - directory with documentation for the Blackfin arch.
Linus Torvalds1da177e2005-04-16 15:20:36 -070081block/
82 - info on the Block I/O (BIO) layer.
83cachetlb.txt
84 - describes the cache/TLB flushing interfaces Linux uses.
85cciss.txt
86 - info, major/minor #'s for Compaq's SMART Array Controllers.
87cdrom/
88 - directory with information on the CD-ROM drivers that Linux has.
89cli-sti-removal.txt
90 - cli()/sti() removal guide.
91computone.txt
92 - info on Computone Intelliport II/Plus Multiport Serial Driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070093connector/
94 - docs on the netlink based userspace<->kernel space communication mod.
95console/
96 - documentation on Linux console drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -070097cpqarray.txt
98 - info on using Compaq's SMART2 Intelligent Disk Array Controllers.
99cpu-freq/
100 - info on CPU frequency and voltage scaling.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700101cpu-hotplug.txt
102 - document describing CPU hotplug support in the Linux kernel.
103cpu-load.txt
104 - document describing how CPU load statistics are collected.
105cpusets.txt
106 - documents the cpusets feature; assign CPUs and Mem to a set of tasks.
107cputopology.txt
108 - documentation on how CPU topology info is exported via sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109cris/
110 - directory with info about Linux on CRIS architecture.
111crypto/
112 - directory with info on the Crypto API.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700113dcdbas.txt
114 - information on the Dell Systems Management Base Driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115debugging-modules.txt
116 - some notes on debugging modules after Linux 2.6.3.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700117dell_rbu.txt
118 - document demonstrating the use of the Dell Remote BIOS Update driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119device-mapper/
120 - directory with info on Device Mapper.
121devices.txt
122 - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
123digiepca.txt
124 - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
125dnotify.txt
126 - info about directory notification in Linux.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700127dontdiff
128 - file containing a list of files that should never be diff'ed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129driver-model/
130 - directory with info about Linux driver model.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700131drivers/
132 - directory with driver documentation (currently only EDAC).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133dvb/
134 - info on Linux Digital Video Broadcast (DVB) subsystem.
135early-userspace/
136 - info about initramfs, klibc, and userspace early during boot.
137eisa.txt
138 - info on EISA bus support.
139exception.txt
140 - how Linux v2.2 handles exceptions without verify_area etc.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700141fault-injection/
142 - dir with docs about the fault injection capabilities infrastructure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143fb/
144 - directory with info on the frame buffer graphics abstraction layer.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700145feature-removal-schedule.txt
146 - list of files and features that are going to be removed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147filesystems/
148 - directory with info on the various filesystems that Linux supports.
149firmware_class/
150 - request_firmware() hotplug interface info.
151floppy.txt
152 - notes and driver options for the floppy disk driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700153fujitsu/
154 - Fujitsu FR-V Linux documentation.
155gpio.txt
156 - overview of GPIO (General Purpose Input/Output) access conventions.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157hayes-esp.txt
158 - info on using the Hayes ESP serial driver.
159highuid.txt
160 - notes on the change from 16 bit to 32 bit user/group IDs.
161hpet.txt
162 - High Precision Event Timer Driver for Linux.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700163hrtimer/
164 - info on the timer_stats debugging facility for timer (ab)use.
165hrtimers/
166 - info on the hrtimers subsystem for high-resolution kernel timers.
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.
175i386/
176 - directory with info about Linux on Intel 32 bit architecture.
177ia64/
178 - directory with info about Linux on Intel 64 bit architecture.
179ide.txt
180 - important info for users of ATA devices (IDE/EIDE disks and CD-ROMS).
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700181infiniband/
182 - directory with documents concerning Linux InfiniBand support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183initrd.txt
184 - how to use the RAM disk as an initial/temporary root filesystem.
185input/
186 - info on Linux input device support.
187io_ordering.txt
188 - info on ordering I/O writes to memory-mapped addresses.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700189ioctl/
190 - directory with documents describing various IOCTL calls.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191ioctl-number.txt
192 - how to implement and register device/driver ioctl calls.
193iostats.txt
194 - info on I/O statistics Linux kernel provides.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700195irqflags-tracing.txt
196 - how to use the irq-flags tracing feature.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197isapnp.txt
198 - info on Linux ISA Plug & Play support.
199isdn/
200 - directory with info on the Linux ISDN support, and supported cards.
201java.txt
202 - info on the in-kernel binary support for Java(tm).
203kbuild/
204 - directory with info about the kernel build process.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700205kdump/
206 - directory with mini HowTo on getting the crash dump code to work.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207kernel-doc-nano-HOWTO.txt
208 - mini HowTo on generation and location of kernel documentation files.
209kernel-docs.txt
210 - listing of various WWW + books that document kernel internals.
211kernel-parameters.txt
212 - summary listing of command line / boot prompt args for the kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700213keys-request-key.txt
214 - description of the kernel key request service.
215keys.txt
216 - description of the kernel key retention service.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217kobject.txt
218 - info of the kobject infrastructure of the Linux kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700219kprobes.txt
220 - documents the kernel probes debugging feature.
221kref.txt
222 - docs on adding reference counters (krefs) to kernel objects.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223laptop-mode.txt
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700224 - how to conserve battery power using laptop-mode.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225ldm.txt
226 - a brief description of LDM (Windows Dynamic Disks).
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700227leds-class.txt
228 - documents LED handling under Linux.
229local_ops.txt
230 - semantics and behavior of local atomic operations.
231lockdep-design.txt
232 - documentation on the runtime locking correctness validator.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233locks.txt
234 - info on file locking implementations, flock() vs. fcntl(), etc.
235logo.gif
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700236 - full colour GIF image of Linux logo (penguin - Tux).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237logo.txt
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700238 - info on creator of above logo & site to get additional images from.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239m68k/
240 - directory with info about Linux on Motorola 68k architecture.
241magic-number.txt
242 - list of magic numbers used to mark/protect kernel data structures.
243mandatory.txt
244 - info on the Linux implementation of Sys V mandatory file locking.
245mca.txt
246 - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
247md.txt
248 - info on boot arguments for the multiple devices driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700249memory-barriers.txt
250 - info on Linux kernel memory barriers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251memory.txt
252 - info on typical Linux memory problems.
253mips/
254 - directory with info about Linux on MIPS architecture.
255mono.txt
256 - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
257moxa-smartio
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700258 - file with info on installing/using Moxa multiport serial driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259mtrr.txt
260 - how to use PPro Memory Type Range Registers to increase performance.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700261mutex-design.txt
262 - info on the generic mutex subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263nbd.txt
264 - info on a TCP implementation of a network block device.
Paul Moore8802f612006-08-03 16:45:49 -0700265netlabel/
266 - directory with information on the NetLabel subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267networking/
268 - directory with info on various aspects of networking with Linux.
269nfsroot.txt
270 - short guide on setting up a diskless box with NFS root filesystem.
271nmi_watchdog.txt
272 - info on NMI watchdog for SMP systems.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700273nommu-mmap.txt
274 - documentation about no-mmu memory mapping support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275numastat.txt
276 - info on how to read Numa policy hit/miss statistics in sysfs.
277oops-tracing.txt
278 - how to decode those nasty internal kernel error dump messages.
279paride.txt
280 - information about the parallel port IDE subsystem.
281parisc/
282 - directory with info on using Linux on PA-RISC architecture.
283parport.txt
284 - how to use the parallel-port driver.
285parport-lowlevel.txt
286 - description and usage of the low level parallel port functions.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700287pci-error-recovery.txt
288 - info on PCI error recovery.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289pci.txt
290 - info on the PCI subsystem for device driver authors.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700291pcieaer-howto.txt
292 - the PCI Express Advanced Error Reporting Driver Guide HOWTO.
293pcmcia/
294 - info on the Linux PCMCIA driver.
295pi-futex.txt
296 - documentation on lightweight PI-futexes.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297pm.txt
298 - info on Linux power management support.
299pnp.txt
300 - Linux Plug and Play documentation.
301power/
302 - directory with info on Linux PCI power management.
303powerpc/
304 - directory with info on using Linux with the PowerPC.
305preempt-locking.txt
306 - info on locking under a preemptive kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700307prio_tree.txt
308 - info on radix-priority-search-tree use for indexing vmas.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309ramdisk.txt
310 - short guide on how to set up and use the RAM disk.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700311rbtree.txt
312 - info on what red-black trees are and what they are for.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313riscom8.txt
314 - notes on using the RISCom/8 multi-port serial driver.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700315robust-futex-ABI.txt
316 - documentation of the robust futex ABI.
317robust-futexes.txt
318 - a description of what robust futexes are.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319rocket.txt
320 - info on the Comtrol RocketPort multiport serial driver.
321rpc-cache.txt
322 - introduction to the caching mechanisms in the sunrpc layer.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700323rt-mutex-design.txt
324 - description of the RealTime mutex implementation design.
325rt-mutex.txt
326 - desc. of RT-mutex subsystem with PI (Priority Inheritance) support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327rtc.txt
328 - notes on how to use the Real Time Clock (aka CMOS clock) driver.
329s390/
330 - directory with info on using Linux on the IBM S390.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700331sched-arch.txt
332 - CPU Scheduler implementation hints for architecture specific code.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333sched-coding.txt
334 - reference for various scheduler-related methods in the O(1) scheduler.
335sched-design.txt
336 - goals, design and implementation of the Linux O(1) scheduler.
337sched-domains.txt
338 - information on scheduling domains.
339sched-stats.txt
340 - information on schedstats (Linux Scheduler Statistics).
341scsi/
342 - directory with info on Linux scsi support.
343serial/
344 - directory with info on the low level serial API.
345serial-console.txt
346 - how to set up Linux with a serial line console as the default.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700347sgi-ioc4.txt
348 - description of the SGI IOC4 PCI (multi function) device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349sgi-visws.txt
350 - short blurb on the SGI Visual Workstations.
351sh/
352 - directory with info on porting Linux to a new architecture.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700353sharedsubtree.txt
354 - a description of shared subtrees for namespaces.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355smart-config.txt
356 - description of the Smart Config makefile feature.
357smp.txt
358 - a few notes on symmetric multi-processing.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700359sony-laptop.txt
360 - Sony Notebook Control Driver (SNC) Readme.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361sonypi.txt
362 - info on Linux Sony Programmable I/O Device support.
363sound/
364 - directory with info on sound card support.
365sparc/
366 - directory with info on using Linux on Sparc architecture.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700367sparse.txt
368 - info on how to obtain and use the sparse tool for typechecking.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369specialix.txt
370 - info on hardware/driver for specialix IO8+ multiport serial card.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700371spi/
372 - overview of Linux kernel Serial Peripheral Interface (SPI) support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373spinlocks.txt
374 - info on using spinlocks to provide exclusive access in kernel.
Greg Kroah-Hartman8907e942005-11-18 09:31:15 -0800375stable_api_nonsense.txt
376 - info on why the kernel does not have a stable in-kernel api or abi.
377stable_kernel_rules.txt
378 - rules and procedures for the -stable kernel releases.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379stallion.txt
380 - info on using the Stallion multiport serial driver.
381svga.txt
382 - short guide on selecting video modes at boot via VGA BIOS.
383sx.txt
384 - info on the Specialix SX/SI multiport serial driver.
385sysctl/
386 - directory with info on the /proc/sys/* files.
387sysrq.txt
388 - info on the magic SysRq key.
389telephony/
390 - directory with info on telephony (e.g. voice over IP) support.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700391thinkpad-acpi.txt
392 - information on the (IBM and Lenovo) ThinkPad ACPI Extras driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393time_interpolators.txt
394 - info on time interpolators.
395tipar.txt
396 - information about Parallel link cable for Texas Instruments handhelds.
397tty.txt
398 - guide to the locking policies of the tty layer.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399uml/
Tobias Klauserd533f672005-09-10 00:26:46 -0700400 - directory with information about User Mode Linux.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700401unicode.txt
402 - info on the Unicode character/font mapping used in Linux.
403unshare.txt
404 - description of the Linux unshare system call.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405usb/
406 - directory with info regarding the Universal Serial Bus.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700407video-output.txt
408 - sysfs class driver interface to enable/disable a video output device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409video4linux/
410 - directory with info regarding video/TV/radio cards and linux.
411vm/
412 - directory with info on the Linux vm code.
413voyager.txt
414 - guide to running Linux on the Voyager architecture.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700415w1/
416 - directory with documents regarding the 1-wire (w1) subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417watchdog/
418 - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
419x86_64/
420 - directory with info on Linux support for AMD x86-64 (Hammer) machines.
421xterm-linux.xpm
422 - XPM image of penguin logo (see logo.txt) sitting on an xterm.
423zorro.txt
424 - info on writing drivers for Zorro bus devices found on Amigas.