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