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