Create/use more directory structure in the Documentation/ tree.
[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 RCU/
46         - directory with info on RCU (read-copy update).
47 SAK.txt
48         - info on Secure Attention Keys.
49 SM501.txt
50         - Silicon Motion SM501 multimedia companion chip
51 SecurityBugs
52         - procedure for reporting security bugs found in the kernel.
53 SubmitChecklist
54         - Linux kernel patch submission checklist.
55 SubmittingDrivers
56         - procedure to get a new driver source included into the kernel tree.
57 SubmittingPatches
58         - procedure to get a source patch included into the kernel tree.
59 VGA-softcursor.txt
60         - how to change your VGA cursor from a blinking underscore.
61 accounting/
62         - documentation on accounting and taskstats.
63 acpi/
64         - info on ACPI-specific hooks in the kernel.
65 aoe/
66         - description of AoE (ATA over Ethernet) along with config examples.
67 applying-patches.txt
68         - description of various trees and how to apply their patches.
69 arm/
70         - directory with info about Linux on the ARM architecture.
71 atomic_ops.txt
72         - semantics and behavior of atomic and bitmask operations.
73 auxdisplay/
74         - misc. LCD driver documentation (cfag12864b, ks0108).
75 basic_profiling.txt
76         - basic instructions for those who wants to profile Linux kernel.
77 binfmt_misc.txt
78         - info on the kernel support for extra binary formats.
79 blackfin/
80         - directory with documentation for the Blackfin arch.
81 block/
82         - info on the Block I/O (BIO) layer.
83 blockdev/
84         - info on block devices & drivers
85 cachetlb.txt
86         - describes the cache/TLB flushing interfaces Linux uses.
87 cdrom/
88         - directory with information on the CD-ROM drivers that Linux has.
89 connector/
90         - docs on the netlink based userspace<->kernel space communication mod.
91 console/
92         - documentation on Linux console drivers.
93 cpu-freq/
94         - info on CPU frequency and voltage scaling.
95 cpu-hotplug.txt
96         - document describing CPU hotplug support in the Linux kernel.
97 cpu-load.txt
98         - document describing how CPU load statistics are collected.
99 cpuidle/
100         - info on CPU_IDLE, CPU idle state management subsystem.
101 cpusets.txt
102         - documents the cpusets feature; assign CPUs and Mem to a set of tasks.
103 cputopology.txt
104         - documentation on how CPU topology info is exported via sysfs.
105 cris/
106         - directory with info about Linux on CRIS architecture.
107 crypto/
108         - directory with info on the Crypto API.
109 dcdbas.txt
110         - information on the Dell Systems Management Base Driver.
111 debugging-modules.txt
112         - some notes on debugging modules after Linux 2.6.3.
113 dell_rbu.txt
114         - document demonstrating the use of the Dell Remote BIOS Update driver.
115 device-mapper/
116         - directory with info on Device Mapper.
117 devices.txt
118         - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
119 dontdiff
120         - file containing a list of files that should never be diff'ed.
121 driver-model/
122         - directory with info about Linux driver model.
123 dvb/
124         - info on Linux Digital Video Broadcast (DVB) subsystem.
125 early-userspace/
126         - info about initramfs, klibc, and userspace early during boot.
127 edac.txt
128         - information on EDAC - Error Detection And Correction
129 eisa.txt
130         - info on EISA bus support.
131 exception.txt
132         - how Linux v2.2 handles exceptions without verify_area etc.
133 fault-injection/
134         - dir with docs about the fault injection capabilities infrastructure.
135 fb/
136         - directory with info on the frame buffer graphics abstraction layer.
137 feature-removal-schedule.txt
138         - list of files and features that are going to be removed.
139 filesystems/
140         - info on the vfs and the various filesystems that Linux supports.
141 firmware_class/
142         - request_firmware() hotplug interface info.
143 frv/
144         - Fujitsu FR-V Linux documentation.
145 gpio.txt
146         - overview of GPIO (General Purpose Input/Output) access conventions.
147 highuid.txt
148         - notes on the change from 16 bit to 32 bit user/group IDs.
149 timers/
150         - info on the timer related topics
151 hw_random.txt
152         - info on Linux support for random number generator in i8xx chipsets.
153 hwmon/
154         - directory with docs on various hardware monitoring drivers.
155 i2c/
156         - directory with info about the I2C bus/protocol (2 wire, kHz speed).
157 i2o/
158         - directory with info about the Linux I2O subsystem.
159 x86/i386/
160         - directory with info about Linux on Intel 32 bit architecture.
161 ia64/
162         - directory with info about Linux on Intel 64 bit architecture.
163 infiniband/
164         - directory with documents concerning Linux InfiniBand support.
165 initrd.txt
166         - how to use the RAM disk as an initial/temporary root filesystem.
167 input/
168         - info on Linux input device support.
169 io_ordering.txt
170         - info on ordering I/O writes to memory-mapped addresses.
171 ioctl/
172         - directory with documents describing various IOCTL calls.
173 iostats.txt
174         - info on I/O statistics Linux kernel provides.
175 irqflags-tracing.txt
176         - how to use the irq-flags tracing feature.
177 isapnp.txt
178         - info on Linux ISA Plug & Play support.
179 isdn/
180         - directory with info on the Linux ISDN support, and supported cards.
181 java.txt
182         - info on the in-kernel binary support for Java(tm).
183 kbuild/
184         - directory with info about the kernel build process.
185 kdump/
186         - directory with mini HowTo on getting the crash dump code to work.
187 kernel-doc-nano-HOWTO.txt
188         - mini HowTo on generation and location of kernel documentation files.
189 kernel-docs.txt
190         - listing of various WWW + books that document kernel internals.
191 kernel-parameters.txt
192         - summary listing of command line / boot prompt args for the kernel.
193 keys-request-key.txt
194         - description of the kernel key request service.
195 keys.txt
196         - description of the kernel key retention service.
197 kobject.txt
198         - info of the kobject infrastructure of the Linux kernel.
199 kprobes.txt
200         - documents the kernel probes debugging feature.
201 kref.txt
202         - docs on adding reference counters (krefs) to kernel objects.
203 laptops/
204         - directory with laptop related info and laptop driver documentation.
205 ldm.txt
206         - a brief description of LDM (Windows Dynamic Disks).
207 leds-class.txt
208         - documents LED handling under Linux.
209 local_ops.txt
210         - semantics and behavior of local atomic operations.
211 lockdep-design.txt
212         - documentation on the runtime locking correctness validator.
213 logo.gif
214         - full colour GIF image of Linux logo (penguin - Tux).
215 logo.txt
216         - info on creator of above logo & site to get additional images from.
217 m68k/
218         - directory with info about Linux on Motorola 68k architecture.
219 magic-number.txt
220         - list of magic numbers used to mark/protect kernel data structures.
221 mca.txt
222         - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
223 md.txt
224         - info on boot arguments for the multiple devices driver.
225 memory-barriers.txt
226         - info on Linux kernel memory barriers.
227 memory-hotplug.txt
228         - Hotpluggable memory support, how to use and current status.
229 memory.txt
230         - info on typical Linux memory problems.
231 mips/
232         - directory with info about Linux on MIPS architecture.
233 mono.txt
234         - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
235 mutex-design.txt
236         - info on the generic mutex subsystem.
237 namespaces/
238         - directory with various information about namespaces
239 netlabel/
240         - directory with information on the NetLabel subsystem.
241 networking/
242         - directory with info on various aspects of networking with Linux.
243 nmi_watchdog.txt
244         - info on NMI watchdog for SMP systems.
245 nommu-mmap.txt
246         - documentation about no-mmu memory mapping support.
247 numastat.txt
248         - info on how to read Numa policy hit/miss statistics in sysfs.
249 oops-tracing.txt
250         - how to decode those nasty internal kernel error dump messages.
251 parisc/
252         - directory with info on using Linux on PA-RISC architecture.
253 parport.txt
254         - how to use the parallel-port driver.
255 parport-lowlevel.txt
256         - description and usage of the low level parallel port functions.
257 pcmcia/
258         - info on the Linux PCMCIA driver.
259 pi-futex.txt
260         - documentation on lightweight PI-futexes.
261 pnp.txt
262         - Linux Plug and Play documentation.
263 power/
264         - directory with info on Linux PCI power management.
265 powerpc/
266         - directory with info on using Linux with the PowerPC.
267 preempt-locking.txt
268         - info on locking under a preemptive kernel.
269 prio_tree.txt
270         - info on radix-priority-search-tree use for indexing vmas.
271 rbtree.txt
272         - info on what red-black trees are and what they are for.
273 robust-futex-ABI.txt
274         - documentation of the robust futex ABI.
275 robust-futexes.txt
276         - a description of what robust futexes are.
277 rt-mutex-design.txt
278         - description of the RealTime mutex implementation design.
279 rt-mutex.txt
280         - desc. of RT-mutex subsystem with PI (Priority Inheritance) support.
281 rtc.txt
282         - notes on how to use the Real Time Clock (aka CMOS clock) driver.
283 s390/
284         - directory with info on using Linux on the IBM S390.
285 scheduler/
286         - directory with info on the scheduler.
287 scsi/
288         - directory with info on Linux scsi support.
289 serial/
290         - directory with info on the low level serial API.
291 serial-console.txt
292         - how to set up Linux with a serial line console as the default.
293 sgi-ioc4.txt
294         - description of the SGI IOC4 PCI (multi function) device.
295 sgi-visws.txt
296         - short blurb on the SGI Visual Workstations.
297 sh/
298         - directory with info on porting Linux to a new architecture.
299 sound/
300         - directory with info on sound card support.
301 sparc/
302         - directory with info on using Linux on Sparc architecture.
303 sparse.txt
304         - info on how to obtain and use the sparse tool for typechecking.
305 spi/
306         - overview of Linux kernel Serial Peripheral Interface (SPI) support.
307 spinlocks.txt
308         - info on using spinlocks to provide exclusive access in kernel.
309 stable_api_nonsense.txt
310         - info on why the kernel does not have a stable in-kernel api or abi.
311 stable_kernel_rules.txt
312         - rules and procedures for the -stable kernel releases.
313 svga.txt
314         - short guide on selecting video modes at boot via VGA BIOS.
315 sysfs-rules.txt
316         - How not to use sysfs.
317 sysctl/
318         - directory with info on the /proc/sys/* files.
319 sysrq.txt
320         - info on the magic SysRq key.
321 telephony/
322         - directory with info on telephony (e.g. voice over IP) support.
323 time_interpolators.txt
324         - info on time interpolators.
325 uml/
326         - directory with information about User Mode Linux.
327 unicode.txt
328         - info on the Unicode character/font mapping used in Linux.
329 unshare.txt
330         - description of the Linux unshare system call.
331 usb/
332         - directory with info regarding the Universal Serial Bus.
333 video-output.txt
334         - sysfs class driver interface to enable/disable a video output device.
335 video4linux/
336         - directory with info regarding video/TV/radio cards and linux.
337 vm/
338         - directory with info on the Linux vm code.
339 volatile-considered-harmful.txt
340         - Why the "volatile" type class should not be used
341 voyager.txt
342         - guide to running Linux on the Voyager architecture.
343 w1/
344         - directory with documents regarding the 1-wire (w1) subsystem.
345 watchdog/
346         - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
347 x86/x86_64/
348         - directory with info on Linux support for AMD x86-64 (Hammer) machines.
349 zorro.txt
350         - info on writing drivers for Zorro bus devices found on Amigas.