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.
8 Following translations are available on the WWW:
10 - Japanese, maintained by the JF Project (JF@linux.or.jp), at
11 http://www.linux.or.jp/JF/
16 - brute force method of doing binary search of patches to find bug.
18 - list of changes that break older software packages.
20 - how the boss likes the C code in the kernel to look.
22 - DMA API, pci_ API & extensions for non-consistent memory machines.
24 - info for PCI drivers using DMA portably across all platforms.
26 - directory with DocBook templates etc. for kernel documentation.
28 - how to access I/O mapped memory from within device drivers.
30 - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
32 - how to select which CPU(s) handle which interrupt events on SMP.
34 - how to (attempt to) manage kernel hackers.
36 - the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ.
38 - directory with info on RCU (read-copy update).
40 - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux.
42 - info on Secure Attention Keys.
44 - procedure to get a new driver source included into the kernel tree.
46 - procedure to get a source patch included into the kernel tree.
48 - how to change your VGA cursor from a blinking underscore.
50 - description of various trees and how to apply their patches.
52 - directory with info about Linux on the ARM architecture.
54 - basic instructions for those who wants to profile Linux kernel.
56 - info on the kernel support for extra binary formats.
58 - info on the Block I/O (BIO) layer.
60 - describes the cache/TLB flushing interfaces Linux uses.
62 - info, major/minor #'s for Compaq's SMART Array Controllers.
64 - directory with information on the CD-ROM drivers that Linux has.
66 - cli()/sti() removal guide.
68 - info on Computone Intelliport II/Plus Multiport Serial Driver.
70 - info on using Compaq's SMART2 Intelligent Disk Array Controllers.
72 - info on CPU frequency and voltage scaling.
74 - directory with info about Linux on CRIS architecture.
76 - directory with info on the Crypto API.
78 - some notes on debugging modules after Linux 2.6.3.
80 - directory with info on Device Mapper.
82 - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
84 - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
86 - info about directory notification in Linux.
88 - directory with info about Linux driver model.
90 - info on Linux Digital Video Broadcast (DVB) subsystem.
92 - info about initramfs, klibc, and userspace early during boot.
94 - info on EISA bus support.
96 - how Linux v2.2 handles exceptions without verify_area etc.
98 - directory with info on the frame buffer graphics abstraction layer.
100 - directory with info on the various filesystems that Linux supports.
102 - request_firmware() hotplug interface info.
104 - notes and driver options for the floppy disk driver.
106 - notes about the floppy tape device driver.
108 - info on using the Hayes ESP serial driver.
110 - notes on the change from 16 bit to 32 bit user/group IDs.
112 - High Precision Event Timer Driver for Linux.
114 - info on Linux support for random number generator in i8xx chipsets.
116 - directory with info about the I2C bus/protocol (2 wire, kHz speed).
118 - directory with info about the Linux I2O subsystem.
120 - directory with info about Linux on Intel 32 bit architecture.
122 - directory with info about Linux on Intel 64 bit architecture.
124 - important info for users of ATA devices (IDE/EIDE disks and CD-ROMS).
126 - how to use the RAM disk as an initial/temporary root filesystem.
128 - info on Linux input device support.
130 - info on ordering I/O writes to memory-mapped addresses.
132 - how to implement and register device/driver ioctl calls.
134 - info on I/O statistics Linux kernel provides.
136 - info on Linux ISA Plug & Play support.
138 - directory with info on the Linux ISDN support, and supported cards.
140 - info on the in-kernel binary support for Java(tm).
142 - directory with info about the kernel build process.
144 - mini HowTo on getting the crash dump code to work.
145 kernel-doc-nano-HOWTO.txt
146 - mini HowTo on generation and location of kernel documentation files.
148 - listing of various WWW + books that document kernel internals.
149 kernel-parameters.txt
150 - summary listing of command line / boot prompt args for the kernel.
152 - info of the kobject infrastructure of the Linux kernel.
154 - How to conserve battery power using laptop-mode.
156 - a brief description of LDM (Windows Dynamic Disks).
158 - info on file locking implementations, flock() vs. fcntl(), etc.
160 - Full colour GIF image of Linux logo (penguin).
162 - Info on creator of above logo & site to get additional images from.
164 - directory with info about Linux on Motorola 68k architecture.
166 - list of magic numbers used to mark/protect kernel data structures.
168 - info on the Linux implementation of Sys V mandatory file locking.
170 - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
172 - info on boot arguments for the multiple devices driver.
174 - info on typical Linux memory problems.
176 - directory with info about Linux on MIPS architecture.
178 - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
180 - info on installing/using Moxa multiport serial driver.
182 - how to use PPro Memory Type Range Registers to increase performance.
184 - info on a TCP implementation of a network block device.
186 - directory with info on various aspects of networking with Linux.
188 - short guide on setting up a diskless box with NFS root filesystem.
190 - info on NMI watchdog for SMP systems.
192 - info on how to read Numa policy hit/miss statistics in sysfs.
194 - how to decode those nasty internal kernel error dump messages.
196 - information about the parallel port IDE subsystem.
198 - directory with info on using Linux on PA-RISC architecture.
200 - how to use the parallel-port driver.
202 - description and usage of the low level parallel port functions.
204 - info on the PCI subsystem for device driver authors.
206 - info on Linux power management support.
208 - Linux Plug and Play documentation.
210 - directory with info on Linux PCI power management.
212 - directory with info on using Linux with the PowerPC.
214 - info on locking under a preemptive kernel.
216 - short guide on how to set up and use the RAM disk.
218 - notes on using the RISCom/8 multi-port serial driver.
220 - info on the Comtrol RocketPort multiport serial driver.
222 - introduction to the caching mechanisms in the sunrpc layer.
224 - notes on how to use the Real Time Clock (aka CMOS clock) driver.
226 - directory with info on using Linux on the IBM S390.
228 - reference for various scheduler-related methods in the O(1) scheduler.
230 - goals, design and implementation of the Linux O(1) scheduler.
232 - information on scheduling domains.
234 - information on schedstats (Linux Scheduler Statistics).
236 - directory with info on Linux scsi support.
238 - directory with info on the low level serial API.
240 - how to set up Linux with a serial line console as the default.
242 - short blurb on the SGI Visual Workstations.
244 - directory with info on porting Linux to a new architecture.
246 - description of the Smart Config makefile feature.
248 - a few notes on symmetric multi-processing.
250 - info on Linux Sony Programmable I/O Device support.
252 - directory with info on sound card support.
254 - directory with info on using Linux on Sparc architecture.
256 - info on hardware/driver for specialix IO8+ multiport serial card.
258 - info on using spinlocks to provide exclusive access in kernel.
260 - info on using the Stallion multiport serial driver.
262 - short guide on selecting video modes at boot via VGA BIOS.
264 - info on the Specialix SX/SI multiport serial driver.
266 - directory with info on the /proc/sys/* files.
268 - info on the magic SysRq key.
270 - directory with info on telephony (e.g. voice over IP) support.
271 time_interpolators.txt
272 - info on time interpolators.
274 - information about Parallel link cable for Texas Instruments handhelds.
276 - guide to the locking policies of the tty layer.
278 - info on the Unicode character/font mapping used in Linux.
280 - directory with information about User Mode Linux.
282 - directory with info regarding the Universal Serial Bus.
284 - directory with info regarding video/TV/radio cards and linux.
286 - directory with info on the Linux vm code.
288 - guide to running Linux on the Voyager architecture.
290 - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
292 - directory with info on Linux support for AMD x86-64 (Hammer) machines.
294 - XPM image of penguin logo (see logo.txt) sitting on an xterm.
296 - info on writing drivers for Zorro bus devices found on Amigas.