DOC: add printk-formats.txt
[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 timers/
166         - info on the timer related topics
167 hw_random.txt
168         - info on Linux support for random number generator in i8xx chipsets.
169 hwmon/
170         - directory with docs on various hardware monitoring drivers.
171 i2c/
172         - directory with info about the I2C bus/protocol (2 wire, kHz speed).
173 i2o/
174         - directory with info about the Linux I2O subsystem.
175 x86/i386/
176         - directory with info about Linux on Intel 32 bit architecture.
177 ia64/
178         - directory with info about Linux on Intel 64 bit architecture.
179 infiniband/
180         - directory with documents concerning Linux InfiniBand support.
181 initrd.txt
182         - how to use the RAM disk as an initial/temporary root filesystem.
183 input/
184         - info on Linux input device support.
185 io_ordering.txt
186         - info on ordering I/O writes to memory-mapped addresses.
187 ioctl/
188         - directory with documents describing various IOCTL calls.
189 ioctl-number.txt
190         - how to implement and register device/driver ioctl calls.
191 iostats.txt
192         - info on I/O statistics Linux kernel provides.
193 irqflags-tracing.txt
194         - how to use the irq-flags tracing feature.
195 isapnp.txt
196         - info on Linux ISA Plug & Play support.
197 isdn/
198         - directory with info on the Linux ISDN support, and supported cards.
199 java.txt
200         - info on the in-kernel binary support for Java(tm).
201 kbuild/
202         - directory with info about the kernel build process.
203 kdump/
204         - directory with mini HowTo on getting the crash dump code to work.
205 kernel-doc-nano-HOWTO.txt
206         - mini HowTo on generation and location of kernel documentation files.
207 kernel-docs.txt
208         - listing of various WWW + books that document kernel internals.
209 kernel-parameters.txt
210         - summary listing of command line / boot prompt args for the kernel.
211 keys-request-key.txt
212         - description of the kernel key request service.
213 keys.txt
214         - description of the kernel key retention service.
215 kobject.txt
216         - info of the kobject infrastructure of the Linux kernel.
217 kprobes.txt
218         - documents the kernel probes debugging feature.
219 kref.txt
220         - docs on adding reference counters (krefs) to kernel objects.
221 laptops/
222         - directory with laptop related info and laptop driver documentation.
223 ldm.txt
224         - a brief description of LDM (Windows Dynamic Disks).
225 leds-class.txt
226         - documents LED handling under Linux.
227 local_ops.txt
228         - semantics and behavior of local atomic operations.
229 lockdep-design.txt
230         - documentation on the runtime locking correctness validator.
231 logo.gif
232         - full colour GIF image of Linux logo (penguin - Tux).
233 logo.txt
234         - info on creator of above logo & site to get additional images from.
235 m68k/
236         - directory with info about Linux on Motorola 68k architecture.
237 magic-number.txt
238         - list of magic numbers used to mark/protect kernel data structures.
239 mca.txt
240         - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
241 md.txt
242         - info on boot arguments for the multiple devices driver.
243 memory-barriers.txt
244         - info on Linux kernel memory barriers.
245 memory-hotplug.txt
246         - Hotpluggable memory support, how to use and current status.
247 memory.txt
248         - info on typical Linux memory problems.
249 mips/
250         - directory with info about Linux on MIPS architecture.
251 mono.txt
252         - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
253 moxa-smartio
254         - file with info on installing/using Moxa multiport serial driver.
255 mutex-design.txt
256         - info on the generic mutex subsystem.
257 namespaces/
258         - directory with various information about namespaces
259 nbd.txt
260         - info on a TCP implementation of a network block device.
261 netlabel/
262         - directory with information on the NetLabel subsystem.
263 networking/
264         - directory with info on various aspects of networking with Linux.
265 nmi_watchdog.txt
266         - info on NMI watchdog for SMP systems.
267 nommu-mmap.txt
268         - documentation about no-mmu memory mapping support.
269 numastat.txt
270         - info on how to read Numa policy hit/miss statistics in sysfs.
271 oops-tracing.txt
272         - how to decode those nasty internal kernel error dump messages.
273 paride.txt
274         - information about the parallel port IDE subsystem.
275 parisc/
276         - directory with info on using Linux on PA-RISC architecture.
277 parport.txt
278         - how to use the parallel-port driver.
279 parport-lowlevel.txt
280         - description and usage of the low level parallel port functions.
281 pcmcia/
282         - info on the Linux PCMCIA driver.
283 pi-futex.txt
284         - documentation on lightweight PI-futexes.
285 pnp.txt
286         - Linux Plug and Play documentation.
287 power/
288         - directory with info on Linux PCI power management.
289 powerpc/
290         - directory with info on using Linux with the PowerPC.
291 preempt-locking.txt
292         - info on locking under a preemptive kernel.
293 printk-formats.txt
294         - how to get printk format specifiers right
295 prio_tree.txt
296         - info on radix-priority-search-tree use for indexing vmas.
297 ramdisk.txt
298         - short guide on how to set up and use the RAM disk.
299 rbtree.txt
300         - info on what red-black trees are and what they are for.
301 riscom8.txt
302         - notes on using the RISCom/8 multi-port serial driver.
303 robust-futex-ABI.txt
304         - documentation of the robust futex ABI.
305 robust-futexes.txt
306         - a description of what robust futexes are.
307 rocket.txt
308         - info on the Comtrol RocketPort multiport serial driver.
309 rt-mutex-design.txt
310         - description of the RealTime mutex implementation design.
311 rt-mutex.txt
312         - desc. of RT-mutex subsystem with PI (Priority Inheritance) support.
313 rtc.txt
314         - notes on how to use the Real Time Clock (aka CMOS clock) driver.
315 s390/
316         - directory with info on using Linux on the IBM S390.
317 scheduler/
318         - directory with info on the scheduler.
319 scsi/
320         - directory with info on Linux scsi support.
321 serial/
322         - directory with info on the low level serial API.
323 serial-console.txt
324         - how to set up Linux with a serial line console as the default.
325 sgi-ioc4.txt
326         - description of the SGI IOC4 PCI (multi function) device.
327 sgi-visws.txt
328         - short blurb on the SGI Visual Workstations.
329 sh/
330         - directory with info on porting Linux to a new architecture.
331 sound/
332         - directory with info on sound card support.
333 sparc/
334         - directory with info on using Linux on Sparc architecture.
335 sparse.txt
336         - info on how to obtain and use the sparse tool for typechecking.
337 specialix.txt
338         - info on hardware/driver for specialix IO8+ multiport serial card.
339 spi/
340         - overview of Linux kernel Serial Peripheral Interface (SPI) support.
341 spinlocks.txt
342         - info on using spinlocks to provide exclusive access in kernel.
343 stable_api_nonsense.txt
344         - info on why the kernel does not have a stable in-kernel api or abi.
345 stable_kernel_rules.txt
346         - rules and procedures for the -stable kernel releases.
347 stallion.txt
348         - info on using the Stallion multiport serial driver.
349 svga.txt
350         - short guide on selecting video modes at boot via VGA BIOS.
351 sysfs-rules.txt
352         - How not to use sysfs.
353 sx.txt
354         - info on the Specialix SX/SI multiport serial driver.
355 sysctl/
356         - directory with info on the /proc/sys/* files.
357 sysrq.txt
358         - info on the magic SysRq key.
359 telephony/
360         - directory with info on telephony (e.g. voice over IP) support.
361 time_interpolators.txt
362         - info on time interpolators.
363 tty.txt
364         - guide to the locking policies of the tty layer.
365 uml/
366         - directory with information about User Mode Linux.
367 unicode.txt
368         - info on the Unicode character/font mapping used in Linux.
369 unshare.txt
370         - description of the Linux unshare system call.
371 usb/
372         - directory with info regarding the Universal Serial Bus.
373 video-output.txt
374         - sysfs class driver interface to enable/disable a video output device.
375 video4linux/
376         - directory with info regarding video/TV/radio cards and linux.
377 vm/
378         - directory with info on the Linux vm code.
379 volatile-considered-harmful.txt
380         - Why the "volatile" type class should not be used
381 voyager.txt
382         - guide to running Linux on the Voyager architecture.
383 w1/
384         - directory with documents regarding the 1-wire (w1) subsystem.
385 watchdog/
386         - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
387 x86/x86_64/
388         - directory with info on Linux support for AMD x86-64 (Hammer) machines.
389 zorro.txt
390         - info on writing drivers for Zorro bus devices found on Amigas.