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 - text file that is used for help when you run "make config"
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 - how to select which CPU(s) handle which interrupt events on SMP.
32 - info on setting up logical volume management (virtual disks etc.)
34 - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux
36 - release notes for Moxa mutiport serial card.
38 - procedure to get a new driver source included into the kernel tree.
40 - procedure to get a source patch included into the kernel tree.
42 - how to change your VGA cursor from a blinking underscore.
44 - directory with info about Linux on the ARM architecture.
46 - info on the kernel support for extra binary formats.
48 - describes the cache/TLB flushing interfaces Linux uses.
50 - info, major/minor #'s for Compaq's SMART Array Controllers.
52 - directory with information on the CD-ROM drivers that Linux has.
54 - info on Computone Intelliport II/Plus Multiport Serial Driver
56 - info on using Compaq's SMART2 Intelligent Disk Array Controllers.
58 - plain ASCII listing of all the nodes in /dev/ with major minor #'s
60 - info on the Digiboard PC/X{i,e,eve} multiport boards.
62 - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
64 - info about directory notification in Linux.
66 - how Linux v2.2 handles exceptions without verify_area etc.
68 - directory with info on the frame buffer graphics abstraction layer.
70 - directory with info on the various filesystems that Linux supports.
72 - notes and driver options for the floppy disk driver.
74 - notes about the floppy tape device driver
76 - info on using the Hayes ESP serial driver.
78 - notes on the change from 16 bit to 32 bit user/group IDs.
80 - directory with info about the I2C bus/protocol (2 wire, kHz speed)
82 - directory with info about Linux on intel 32 bit architecture.
84 - directory with info about Linux on intel 64 bit architecture.
86 - important info for users of ATA devices (IDE/EIDE disks and CD-ROMS)
88 - how to use the RAM disk as an initial/temporary root filesystem.
90 - how to implement and register device/driver ioctl calls.
92 - info on Linux ISA Plug & Play support
94 - directory with info on the Linux ISDN support, and supported cards.
96 - info on the in-kernel binary support for Java(tm)
98 - API specification for applications that will be using the joystick.
100 - info on how to hook joysticks/gamepads to the parallel port.
102 - info on using joystick devices (and driver) with Linux.
104 - directory with info about the kernel build process
105 kernel-doc-nano-HOWTO.txt
106 - mini HowTo on generation and location of kernel documentation files.
108 - listing of various WWW + books that document kernel internals.
109 kernel-parameters.txt
110 - summary listing of command line / boot prompt args for the kernel.
112 - info on the kernel module loader/unloader (kerneld replacement).
114 - info on file locking implementations, flock() vs. fcntl(), etc.
116 - Full colour GIF image of Linux logo (penguin)
118 - Info on creator of above logo & site to get additional images from.
120 - directory with info about Linux on Motorola 68k architecture.
122 - list of magic numbers used to mark/protect kernel data structures.
124 - info on the Linux implementation of Sys V mandatory file locking.
126 - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
128 - info on boot arguments for the multiple devices driver
130 - info on typical Linux memory problems.
132 - script to make /dev entries for SMART controllers (see cciss.txt)
134 - script to make /dev entries for Intelligent Disk Array Controllers.
136 - short guide on how to make kernel parts into loadable modules
138 - info on installing/using Moxa multiport serial driver.
140 - how to use PPro Memory Type Range Registers to increase performance
142 - info on a TCP implementation of a network block device.
144 - directory with info on various aspects of networking with Linux.
146 - short guide on setting up a diskless box with NFS root filesystem
148 - info on NMI watchdog for SMP systems
150 - how to decode those nasty internal kernel error dump messages.
152 - information about the parallel port IDE subsystem.
154 - directory with info on using Linux on PA-RISC architecture.
156 - how to use the parallel-port driver.
158 - description and usage of the low level parallel port functions.
160 - info on the PCI subsystem for device driver authors
162 - info and sample code for using with the PC Watchdog reset card.
164 - info on Linux power management support
166 - directory with info on using Linux with the PowerPC.
168 - short guide on how to set up and use the RAM disk.
170 - notes on using the RISCom/8 multi-port serial driver.
172 - notes on how to use the Real Time Clock (aka CMOS clock) driver.
174 - directory with info on using Linux on the IBM S390.
176 - info on the sg driver for generic (non-disk/CD/tape) SCSI devices.
178 - short blurb on using SCSI support as a module.
180 - how to set up Linux with a serial line console as the default.
182 - short blurb on the SGI Visual Workstations.
184 - description of the Smart Config makefile feature.
186 - LaTeX document describing implementation of Multiprocessor Linux
188 - a few more notes on symmetric multi-processing
190 - directory with info on sound card support
192 - directory with info on using Linux on Sparc architecture.
194 - info on hardware/driver for specialix IO8+ multiport serial card.
196 - info on using spinlocks to provide exclusive access in kernel.
198 - info on using the Stallion multiport serial driver.
200 - short guide on selecting video modes at boot via VGA BIOS.
202 - info on the Specialix SX/SI multiport serial driver.
204 - directory with info on the /proc/sys/* files
206 - info on the magic SysRq key
208 - directory with info on telephony (e.g. voice over IP) support.
210 - info on the Unicode character/font mapping used in Linux.
212 - directory with info regarding the Universal Serial Bus.
214 - directory with info regarding video/TV/radio cards and linux.
216 - directory with info on the Linux vm code.
218 - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
220 - XPM image of penguin logo (see logo.txt) sitting on an xterm.
222 - info on writing drivers for Zorro bus devices found on Amigas.