Documentation: move rpc-cache.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
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 cpuidle/
113         - info on CPU_IDLE, CPU idle state management subsystem.
114 cpusets.txt
115         - documents the cpusets feature; assign CPUs and Mem to a set of tasks.
116 cputopology.txt
117         - documentation on how CPU topology info is exported via sysfs.
118 cris/
119         - directory with info about Linux on CRIS architecture.
120 crypto/
121         - directory with info on the Crypto API.
122 dcdbas.txt
123         - information on the Dell Systems Management Base Driver.
124 debugging-modules.txt
125         - some notes on debugging modules after Linux 2.6.3.
126 dell_rbu.txt
127         - document demonstrating the use of the Dell Remote BIOS Update driver.
128 device-mapper/
129         - directory with info on Device Mapper.
130 devices.txt
131         - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
132 digiepca.txt
133         - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
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 dvb/
139         - info on Linux Digital Video Broadcast (DVB) subsystem.
140 early-userspace/
141         - info about initramfs, klibc, and userspace early during boot.
142 edac.txt
143         - information on EDAC - Error Detection And Correction
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 frv/
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 infiniband/
187         - directory with documents concerning Linux InfiniBand support.
188 initrd.txt
189         - how to use the RAM disk as an initial/temporary root filesystem.
190 input/
191         - info on Linux input device support.
192 io_ordering.txt
193         - info on ordering I/O writes to memory-mapped addresses.
194 ioctl/
195         - directory with documents describing various IOCTL calls.
196 ioctl-number.txt
197         - how to implement and register device/driver ioctl calls.
198 iostats.txt
199         - info on I/O statistics Linux kernel provides.
200 irqflags-tracing.txt
201         - how to use the irq-flags tracing feature.
202 isapnp.txt
203         - info on Linux ISA Plug & Play support.
204 isdn/
205         - directory with info on the Linux ISDN support, and supported cards.
206 java.txt
207         - info on the in-kernel binary support for Java(tm).
208 kbuild/
209         - directory with info about the kernel build process.
210 kdump/
211         - directory with mini HowTo on getting the crash dump code to work.
212 kernel-doc-nano-HOWTO.txt
213         - mini HowTo on generation and location of kernel documentation files.
214 kernel-docs.txt
215         - listing of various WWW + books that document kernel internals.
216 kernel-parameters.txt
217         - summary listing of command line / boot prompt args for the kernel.
218 keys-request-key.txt
219         - description of the kernel key request service.
220 keys.txt
221         - description of the kernel key retention service.
222 kobject.txt
223         - info of the kobject infrastructure of the Linux kernel.
224 kprobes.txt
225         - documents the kernel probes debugging feature.
226 kref.txt
227         - docs on adding reference counters (krefs) to kernel objects.
228 laptops/
229         - directory with laptop related info and laptop driver documentation.
230 ldm.txt
231         - a brief description of LDM (Windows Dynamic Disks).
232 leds-class.txt
233         - documents LED handling under Linux.
234 local_ops.txt
235         - semantics and behavior of local atomic operations.
236 lockdep-design.txt
237         - documentation on the runtime locking correctness validator.
238 logo.gif
239         - full colour GIF image of Linux logo (penguin - Tux).
240 logo.txt
241         - info on creator of above logo & site to get additional images from.
242 m68k/
243         - directory with info about Linux on Motorola 68k architecture.
244 magic-number.txt
245         - list of magic numbers used to mark/protect kernel data structures.
246 mca.txt
247         - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
248 md.txt
249         - info on boot arguments for the multiple devices driver.
250 memory-barriers.txt
251         - info on Linux kernel memory barriers.
252 memory-hotplug.txt
253         - Hotpluggable memory support, how to use and current status.
254 memory.txt
255         - info on typical Linux memory problems.
256 mips/
257         - directory with info about Linux on MIPS architecture.
258 mono.txt
259         - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
260 moxa-smartio
261         - file with info on installing/using Moxa multiport serial driver.
262 mtrr.txt
263         - how to use PPro Memory Type Range Registers to increase performance.
264 mutex-design.txt
265         - info on the generic mutex subsystem.
266 namespaces/
267         - directory with various information about namespaces
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 nmi_watchdog.txt
275         - info on NMI watchdog for SMP systems.
276 nommu-mmap.txt
277         - documentation about no-mmu memory mapping support.
278 numastat.txt
279         - info on how to read Numa policy hit/miss statistics in sysfs.
280 oops-tracing.txt
281         - how to decode those nasty internal kernel error dump messages.
282 paride.txt
283         - information about the parallel port IDE subsystem.
284 parisc/
285         - directory with info on using Linux on PA-RISC architecture.
286 parport.txt
287         - how to use the parallel-port driver.
288 parport-lowlevel.txt
289         - description and usage of the low level parallel port functions.
290 pci-error-recovery.txt
291         - info on PCI error recovery.
292 pci.txt
293         - info on the PCI subsystem for device driver authors.
294 pcieaer-howto.txt
295         - the PCI Express Advanced Error Reporting Driver Guide HOWTO.
296 pcmcia/
297         - info on the Linux PCMCIA driver.
298 pi-futex.txt
299         - documentation on lightweight PI-futexes.
300 pnp.txt
301         - Linux Plug and Play documentation.
302 power/
303         - directory with info on Linux PCI power management.
304 powerpc/
305         - directory with info on using Linux with the PowerPC.
306 preempt-locking.txt
307         - info on locking under a preemptive kernel.
308 prio_tree.txt
309         - info on radix-priority-search-tree use for indexing vmas.
310 ramdisk.txt
311         - short guide on how to set up and use the RAM disk.
312 rbtree.txt
313         - info on what red-black trees are and what they are for.
314 riscom8.txt
315         - notes on using the RISCom/8 multi-port serial driver.
316 robust-futex-ABI.txt
317         - documentation of the robust futex ABI.
318 robust-futexes.txt
319         - a description of what robust futexes are.
320 rocket.txt
321         - info on the Comtrol RocketPort multiport serial driver.
322 rt-mutex-design.txt
323         - description of the RealTime mutex implementation design.
324 rt-mutex.txt
325         - desc. of RT-mutex subsystem with PI (Priority Inheritance) support.
326 rtc.txt
327         - notes on how to use the Real Time Clock (aka CMOS clock) driver.
328 s390/
329         - directory with info on using Linux on the IBM S390.
330 scheduler/
331         - directory with info on the scheduler.
332 scsi/
333         - directory with info on Linux scsi support.
334 serial/
335         - directory with info on the low level serial API.
336 serial-console.txt
337         - how to set up Linux with a serial line console as the default.
338 sgi-ioc4.txt
339         - description of the SGI IOC4 PCI (multi function) device.
340 sgi-visws.txt
341         - short blurb on the SGI Visual Workstations.
342 sh/
343         - directory with info on porting Linux to a new architecture.
344 smart-config.txt
345         - description of the Smart Config makefile feature.
346 sound/
347         - directory with info on sound card support.
348 sparc/
349         - directory with info on using Linux on Sparc architecture.
350 sparse.txt
351         - info on how to obtain and use the sparse tool for typechecking.
352 specialix.txt
353         - info on hardware/driver for specialix IO8+ multiport serial card.
354 spi/
355         - overview of Linux kernel Serial Peripheral Interface (SPI) support.
356 spinlocks.txt
357         - info on using spinlocks to provide exclusive access in kernel.
358 stable_api_nonsense.txt
359         - info on why the kernel does not have a stable in-kernel api or abi.
360 stable_kernel_rules.txt
361         - rules and procedures for the -stable kernel releases.
362 stallion.txt
363         - info on using the Stallion multiport serial driver.
364 svga.txt
365         - short guide on selecting video modes at boot via VGA BIOS.
366 sysfs-rules.txt
367         - How not to use sysfs.
368 sx.txt
369         - info on the Specialix SX/SI multiport serial driver.
370 sysctl/
371         - directory with info on the /proc/sys/* files.
372 sysrq.txt
373         - info on the magic SysRq key.
374 telephony/
375         - directory with info on telephony (e.g. voice over IP) support.
376 time_interpolators.txt
377         - info on time interpolators.
378 tipar.txt
379         - information about Parallel link cable for Texas Instruments handhelds.
380 tty.txt
381         - guide to the locking policies of the tty layer.
382 uml/
383         - directory with information about User Mode Linux.
384 unicode.txt
385         - info on the Unicode character/font mapping used in Linux.
386 unshare.txt
387         - description of the Linux unshare system call.
388 usb/
389         - directory with info regarding the Universal Serial Bus.
390 video-output.txt
391         - sysfs class driver interface to enable/disable a video output device.
392 video4linux/
393         - directory with info regarding video/TV/radio cards and linux.
394 vm/
395         - directory with info on the Linux vm code.
396 volatile-considered-harmful.txt
397         - Why the "volatile" type class should not be used
398 voyager.txt
399         - guide to running Linux on the Voyager architecture.
400 w1/
401         - directory with documents regarding the 1-wire (w1) subsystem.
402 watchdog/
403         - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
404 x86_64/
405         - directory with info on Linux support for AMD x86-64 (Hammer) machines.
406 zorro.txt
407         - info on writing drivers for Zorro bus devices found on Amigas.