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