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