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