Merge branch 'linus' into timers/hpet
[linux-2.6.git] / Documentation / 00-INDEX
1
2 This is a brief list of all the files in ./linux/Documentation and what
3 they contain. If you add a documentation file, please list it here in
4 alphabetical order as well, or risk being hunted down like a rabid dog.
5 Please try and keep the descriptions small enough to fit on one line.
6                                                          Thanks -- Paul G.
7
8 Following 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
13 00-INDEX
14         - this file.
15 ABI/
16         - info on kernel <-> userspace ABI and relative interface stability.
17
18 BUG-HUNTING
19         - brute force method of doing binary search of patches to find bug.
20 Changes
21         - list of changes that break older software packages.
22 CodingStyle
23         - how the boss likes the C code in the kernel to look.
24 DMA-API.txt
25         - DMA API, pci_ API & extensions for non-consistent memory machines.
26 DMA-ISA-LPC.txt
27         - How to do DMA with ISA (and LPC) devices.
28 DocBook/
29         - directory with DocBook templates etc. for kernel documentation.
30 HOWTO
31         - the process and procedures of how to do Linux kernel development.
32 IO-mapping.txt
33         - how to access I/O mapped memory from within device drivers.
34 IPMI.txt
35         - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
36 IRQ-affinity.txt
37         - how to select which CPU(s) handle which interrupt events on SMP.
38 IRQ.txt
39         - description of what an IRQ is.
40 ManagementStyle
41         - how to (attempt to) manage kernel hackers.
42 MSI-HOWTO.txt
43         - the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ.
44 RCU/
45         - directory with info on RCU (read-copy update).
46 README.DAC960
47         - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux.
48 README.cycladesZ
49         - info on Cyclades-Z firmware loading.
50 SAK.txt
51         - info on Secure Attention Keys.
52 SM501.txt
53         - Silicon Motion SM501 multimedia companion chip
54 SecurityBugs
55         - procedure for reporting security bugs found in the kernel.
56 SubmitChecklist
57         - Linux kernel patch submission checklist.
58 SubmittingDrivers
59         - procedure to get a new driver source included into the kernel tree.
60 SubmittingPatches
61         - procedure to get a source patch included into the kernel tree.
62 VGA-softcursor.txt
63         - how to change your VGA cursor from a blinking underscore.
64 accounting/
65         - documentation on accounting and taskstats.
66 acpi/
67         - info on ACPI-specific hooks in the kernel.
68 aoe/
69         - description of AoE (ATA over Ethernet) along with config examples.
70 applying-patches.txt
71         - description of various trees and how to apply their patches.
72 arm/
73         - directory with info about Linux on the ARM architecture.
74 atomic_ops.txt
75         - semantics and behavior of atomic and bitmask operations.
76 auxdisplay/
77         - misc. LCD driver documentation (cfag12864b, ks0108).
78 basic_profiling.txt
79         - basic instructions for those who wants to profile Linux kernel.
80 binfmt_misc.txt
81         - info on the kernel support for extra binary formats.
82 blackfin/
83         - directory with documentation for the Blackfin arch.
84 block/
85         - info on the Block I/O (BIO) layer.
86 cachetlb.txt
87         - describes the cache/TLB flushing interfaces Linux uses.
88 cciss.txt
89         - info, major/minor #'s for Compaq's SMART Array Controllers.
90 cdrom/
91         - directory with information on the CD-ROM drivers that Linux has.
92 cli-sti-removal.txt
93         - cli()/sti() removal guide.
94 computone.txt
95         - info on Computone Intelliport II/Plus Multiport Serial Driver.
96 connector/
97         - docs on the netlink based userspace<->kernel space communication mod.
98 console/
99         - documentation on Linux console drivers.
100 cpqarray.txt
101         - info on using Compaq's SMART2 Intelligent Disk Array Controllers.
102 cpu-freq/
103         - info on CPU frequency and voltage scaling.
104 cpu-hotplug.txt
105         - document describing CPU hotplug support in the Linux kernel.
106 cpu-load.txt
107         - document describing how CPU load statistics are collected.
108 cpuidle/
109         - info on CPU_IDLE, CPU idle state management subsystem.
110 cpusets.txt
111         - documents the cpusets feature; assign CPUs and Mem to a set of tasks.
112 cputopology.txt
113         - documentation on how CPU topology info is exported via sysfs.
114 cris/
115         - directory with info about Linux on CRIS architecture.
116 crypto/
117         - directory with info on the Crypto API.
118 dcdbas.txt
119         - information on the Dell Systems Management Base Driver.
120 debugging-modules.txt
121         - some notes on debugging modules after Linux 2.6.3.
122 dell_rbu.txt
123         - document demonstrating the use of the Dell Remote BIOS Update driver.
124 device-mapper/
125         - directory with info on Device Mapper.
126 devices.txt
127         - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
128 digiepca.txt
129         - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
130 dontdiff
131         - file containing a list of files that should never be diff'ed.
132 driver-model/
133         - directory with info about Linux driver model.
134 dvb/
135         - info on Linux Digital Video Broadcast (DVB) subsystem.
136 early-userspace/
137         - info about initramfs, klibc, and userspace early during boot.
138 edac.txt
139         - information on EDAC - Error Detection And Correction
140 eisa.txt
141         - info on EISA bus support.
142 exception.txt
143         - how Linux v2.2 handles exceptions without verify_area etc.
144 fault-injection/
145         - dir with docs about the fault injection capabilities infrastructure.
146 fb/
147         - directory with info on the frame buffer graphics abstraction layer.
148 feature-removal-schedule.txt
149         - list of files and features that are going to be removed.
150 filesystems/
151         - info on the vfs and the various filesystems that Linux supports.
152 firmware_class/
153         - request_firmware() hotplug interface info.
154 floppy.txt
155         - notes and driver options for the floppy disk driver.
156 frv/
157         - Fujitsu FR-V Linux documentation.
158 gpio.txt
159         - overview of GPIO (General Purpose Input/Output) access conventions.
160 hayes-esp.txt
161         - info on using the Hayes ESP serial driver.
162 highuid.txt
163         - notes on the change from 16 bit to 32 bit user/group IDs.
164 timers/
165         - info on the timer related topics
166 hw_random.txt
167         - info on Linux support for random number generator in i8xx chipsets.
168 hwmon/
169         - directory with docs on various hardware monitoring drivers.
170 i2c/
171         - directory with info about the I2C bus/protocol (2 wire, kHz speed).
172 i2o/
173         - directory with info about the Linux I2O subsystem.
174 i386/
175         - directory with info about Linux on Intel 32 bit architecture.
176 ia64/
177         - directory with info about Linux on Intel 64 bit architecture.
178 infiniband/
179         - directory with documents concerning Linux InfiniBand support.
180 initrd.txt
181         - how to use the RAM disk as an initial/temporary root filesystem.
182 input/
183         - info on Linux input device support.
184 io_ordering.txt
185         - info on ordering I/O writes to memory-mapped addresses.
186 ioctl/
187         - directory with documents describing various IOCTL calls.
188 ioctl-number.txt
189         - how to implement and register device/driver ioctl calls.
190 iostats.txt
191         - info on I/O statistics Linux kernel provides.
192 irqflags-tracing.txt
193         - how to use the irq-flags tracing feature.
194 isapnp.txt
195         - info on Linux ISA Plug & Play support.
196 isdn/
197         - directory with info on the Linux ISDN support, and supported cards.
198 java.txt
199         - info on the in-kernel binary support for Java(tm).
200 kbuild/
201         - directory with info about the kernel build process.
202 kdump/
203         - directory with mini HowTo on getting the crash dump code to work.
204 kernel-doc-nano-HOWTO.txt
205         - mini HowTo on generation and location of kernel documentation files.
206 kernel-docs.txt
207         - listing of various WWW + books that document kernel internals.
208 kernel-parameters.txt
209         - summary listing of command line / boot prompt args for the kernel.
210 keys-request-key.txt
211         - description of the kernel key request service.
212 keys.txt
213         - description of the kernel key retention service.
214 kobject.txt
215         - info of the kobject infrastructure of the Linux kernel.
216 kprobes.txt
217         - documents the kernel probes debugging feature.
218 kref.txt
219         - docs on adding reference counters (krefs) to kernel objects.
220 laptops/
221         - directory with laptop related info and laptop driver documentation.
222 ldm.txt
223         - a brief description of LDM (Windows Dynamic Disks).
224 leds-class.txt
225         - documents LED handling under Linux.
226 local_ops.txt
227         - semantics and behavior of local atomic operations.
228 lockdep-design.txt
229         - documentation on the runtime locking correctness validator.
230 logo.gif
231         - full colour GIF image of Linux logo (penguin - Tux).
232 logo.txt
233         - info on creator of above logo & site to get additional images from.
234 m68k/
235         - directory with info about Linux on Motorola 68k architecture.
236 magic-number.txt
237         - list of magic numbers used to mark/protect kernel data structures.
238 mca.txt
239         - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
240 md.txt
241         - info on boot arguments for the multiple devices driver.
242 memory-barriers.txt
243         - info on Linux kernel memory barriers.
244 memory-hotplug.txt
245         - Hotpluggable memory support, how to use and current status.
246 memory.txt
247         - info on typical Linux memory problems.
248 mips/
249         - directory with info about Linux on MIPS architecture.
250 mono.txt
251         - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
252 moxa-smartio
253         - file with info on installing/using Moxa multiport serial driver.
254 mtrr.txt
255         - how to use PPro Memory Type Range Registers to increase performance.
256 mutex-design.txt
257         - info on the generic mutex subsystem.
258 namespaces/
259         - directory with various information about namespaces
260 nbd.txt
261         - info on a TCP implementation of a network block device.
262 netlabel/
263         - directory with information on the NetLabel subsystem.
264 networking/
265         - directory with info on various aspects of networking with Linux.
266 nmi_watchdog.txt
267         - info on NMI watchdog for SMP systems.
268 nommu-mmap.txt
269         - documentation about no-mmu memory mapping support.
270 numastat.txt
271         - info on how to read Numa policy hit/miss statistics in sysfs.
272 oops-tracing.txt
273         - how to decode those nasty internal kernel error dump messages.
274 paride.txt
275         - information about the parallel port IDE subsystem.
276 parisc/
277         - directory with info on using Linux on PA-RISC architecture.
278 parport.txt
279         - how to use the parallel-port driver.
280 parport-lowlevel.txt
281         - description and usage of the low level parallel port functions.
282 pcmcia/
283         - info on the Linux PCMCIA driver.
284 pi-futex.txt
285         - documentation on lightweight PI-futexes.
286 pnp.txt
287         - Linux Plug and Play documentation.
288 power/
289         - directory with info on Linux PCI power management.
290 powerpc/
291         - directory with info on using Linux with the PowerPC.
292 preempt-locking.txt
293         - info on locking under a preemptive kernel.
294 prio_tree.txt
295         - info on radix-priority-search-tree use for indexing vmas.
296 ramdisk.txt
297         - short guide on how to set up and use the RAM disk.
298 rbtree.txt
299         - info on what red-black trees are and what they are for.
300 riscom8.txt
301         - notes on using the RISCom/8 multi-port serial driver.
302 robust-futex-ABI.txt
303         - documentation of the robust futex ABI.
304 robust-futexes.txt
305         - a description of what robust futexes are.
306 rocket.txt
307         - info on the Comtrol RocketPort multiport serial driver.
308 rt-mutex-design.txt
309         - description of the RealTime mutex implementation design.
310 rt-mutex.txt
311         - desc. of RT-mutex subsystem with PI (Priority Inheritance) support.
312 rtc.txt
313         - notes on how to use the Real Time Clock (aka CMOS clock) driver.
314 s390/
315         - directory with info on using Linux on the IBM S390.
316 scheduler/
317         - directory with info on the scheduler.
318 scsi/
319         - directory with info on Linux scsi support.
320 serial/
321         - directory with info on the low level serial API.
322 serial-console.txt
323         - how to set up Linux with a serial line console as the default.
324 sgi-ioc4.txt
325         - description of the SGI IOC4 PCI (multi function) device.
326 sgi-visws.txt
327         - short blurb on the SGI Visual Workstations.
328 sh/
329         - directory with info on porting Linux to a new architecture.
330 sound/
331         - directory with info on sound card support.
332 sparc/
333         - directory with info on using Linux on Sparc architecture.
334 sparse.txt
335         - info on how to obtain and use the sparse tool for typechecking.
336 specialix.txt
337         - info on hardware/driver for specialix IO8+ multiport serial card.
338 spi/
339         - overview of Linux kernel Serial Peripheral Interface (SPI) support.
340 spinlocks.txt
341         - info on using spinlocks to provide exclusive access in kernel.
342 stable_api_nonsense.txt
343         - info on why the kernel does not have a stable in-kernel api or abi.
344 stable_kernel_rules.txt
345         - rules and procedures for the -stable kernel releases.
346 stallion.txt
347         - info on using the Stallion multiport serial driver.
348 svga.txt
349         - short guide on selecting video modes at boot via VGA BIOS.
350 sysfs-rules.txt
351         - How not to use sysfs.
352 sx.txt
353         - info on the Specialix SX/SI multiport serial driver.
354 sysctl/
355         - directory with info on the /proc/sys/* files.
356 sysrq.txt
357         - info on the magic SysRq key.
358 telephony/
359         - directory with info on telephony (e.g. voice over IP) support.
360 time_interpolators.txt
361         - info on time interpolators.
362 tty.txt
363         - guide to the locking policies of the tty layer.
364 uml/
365         - directory with information about User Mode Linux.
366 unicode.txt
367         - info on the Unicode character/font mapping used in Linux.
368 unshare.txt
369         - description of the Linux unshare system call.
370 usb/
371         - directory with info regarding the Universal Serial Bus.
372 video-output.txt
373         - sysfs class driver interface to enable/disable a video output device.
374 video4linux/
375         - directory with info regarding video/TV/radio cards and linux.
376 vm/
377         - directory with info on the Linux vm code.
378 volatile-considered-harmful.txt
379         - Why the "volatile" type class should not be used
380 voyager.txt
381         - guide to running Linux on the Voyager architecture.
382 w1/
383         - directory with documents regarding the 1-wire (w1) subsystem.
384 watchdog/
385         - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
386 x86_64/
387         - directory with info on Linux support for AMD x86-64 (Hammer) machines.
388 zorro.txt
389         - info on writing drivers for Zorro bus devices found on Amigas.