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. 15BUG-HUNTING 16 - brute force method of doing binary search of patches to find bug. 17Changes 18 - list of changes that break older software packages. 19CodingStyle 20 - how the boss likes the C code in the kernel to look. 21DMA-API.txt 22 - DMA API, pci_ API & extensions for non-consistent memory machines. 23DMA-mapping.txt 24 - info for PCI drivers using DMA portably across all platforms. 25DocBook/ 26 - directory with DocBook templates etc. for kernel documentation. 27HOWTO 28 - The process and procedures of how to do Linux kernel development. 29IO-mapping.txt 30 - how to access I/O mapped memory from within device drivers. 31IPMI.txt 32 - info on Linux Intelligent Platform Management Interface (IPMI) Driver. 33IRQ-affinity.txt 34 - how to select which CPU(s) handle which interrupt events on SMP. 35ManagementStyle 36 - how to (attempt to) manage kernel hackers. 37MSI-HOWTO.txt 38 - the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ. 39RCU/ 40 - directory with info on RCU (read-copy update). 41README.DAC960 42 - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux. 43SAK.txt 44 - info on Secure Attention Keys. 45SubmittingDrivers 46 - procedure to get a new driver source included into the kernel tree. 47SubmittingPatches 48 - procedure to get a source patch included into the kernel tree. 49VGA-softcursor.txt 50 - how to change your VGA cursor from a blinking underscore. 51applying-patches.txt 52 - description of various trees and how to apply their patches. 53arm/ 54 - directory with info about Linux on the ARM architecture. 55basic_profiling.txt 56 - basic instructions for those who wants to profile Linux kernel. 57binfmt_misc.txt 58 - info on the kernel support for extra binary formats. 59block/ 60 - info on the Block I/O (BIO) layer. 61cachetlb.txt 62 - describes the cache/TLB flushing interfaces Linux uses. 63cciss.txt 64 - info, major/minor #'s for Compaq's SMART Array Controllers. 65cdrom/ 66 - directory with information on the CD-ROM drivers that Linux has. 67cli-sti-removal.txt 68 - cli()/sti() removal guide. 69computone.txt 70 - info on Computone Intelliport II/Plus Multiport Serial Driver. 71cpqarray.txt 72 - info on using Compaq's SMART2 Intelligent Disk Array Controllers. 73cpu-freq/ 74 - info on CPU frequency and voltage scaling. 75cris/ 76 - directory with info about Linux on CRIS architecture. 77crypto/ 78 - directory with info on the Crypto API. 79debugging-modules.txt 80 - some notes on debugging modules after Linux 2.6.3. 81device-mapper/ 82 - directory with info on Device Mapper. 83devices.txt 84 - plain ASCII listing of all the nodes in /dev/ with major minor #'s. 85digiepca.txt 86 - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards. 87dnotify.txt 88 - info about directory notification in Linux. 89driver-model/ 90 - directory with info about Linux driver model. 91dvb/ 92 - info on Linux Digital Video Broadcast (DVB) subsystem. 93early-userspace/ 94 - info about initramfs, klibc, and userspace early during boot. 95eisa.txt 96 - info on EISA bus support. 97exception.txt 98 - how Linux v2.2 handles exceptions without verify_area etc. 99fb/ 100 - directory with info on the frame buffer graphics abstraction layer. 101filesystems/ 102 - directory with info on the various filesystems that Linux supports. 103firmware_class/ 104 - request_firmware() hotplug interface info. 105floppy.txt 106 - notes and driver options for the floppy disk driver. 107hayes-esp.txt 108 - info on using the Hayes ESP serial driver. 109highuid.txt 110 - notes on the change from 16 bit to 32 bit user/group IDs. 111hpet.txt 112 - High Precision Event Timer Driver for Linux. 113hw_random.txt 114 - info on Linux support for random number generator in i8xx chipsets. 115i2c/ 116 - directory with info about the I2C bus/protocol (2 wire, kHz speed). 117i2o/ 118 - directory with info about the Linux I2O subsystem. 119i386/ 120 - directory with info about Linux on Intel 32 bit architecture. 121ia64/ 122 - directory with info about Linux on Intel 64 bit architecture. 123ide.txt 124 - important info for users of ATA devices (IDE/EIDE disks and CD-ROMS). 125initrd.txt 126 - how to use the RAM disk as an initial/temporary root filesystem. 127input/ 128 - info on Linux input device support. 129io_ordering.txt 130 - info on ordering I/O writes to memory-mapped addresses. 131ioctl-number.txt 132 - how to implement and register device/driver ioctl calls. 133iostats.txt 134 - info on I/O statistics Linux kernel provides. 135isapnp.txt 136 - info on Linux ISA Plug & Play support. 137isdn/ 138 - directory with info on the Linux ISDN support, and supported cards. 139java.txt 140 - info on the in-kernel binary support for Java(tm). 141kbuild/ 142 - directory with info about the kernel build process. 143kdumpt.txt 144 - mini HowTo on getting the crash dump code to work. 145kernel-doc-nano-HOWTO.txt 146 - mini HowTo on generation and location of kernel documentation files. 147kernel-docs.txt 148 - listing of various WWW + books that document kernel internals. 149kernel-parameters.txt 150 - summary listing of command line / boot prompt args for the kernel. 151kobject.txt 152 - info of the kobject infrastructure of the Linux kernel. 153laptop-mode.txt 154 - How to conserve battery power using laptop-mode. 155ldm.txt 156 - a brief description of LDM (Windows Dynamic Disks). 157locks.txt 158 - info on file locking implementations, flock() vs. fcntl(), etc. 159logo.gif 160 - Full colour GIF image of Linux logo (penguin). 161logo.txt 162 - Info on creator of above logo & site to get additional images from. 163m68k/ 164 - directory with info about Linux on Motorola 68k architecture. 165magic-number.txt 166 - list of magic numbers used to mark/protect kernel data structures. 167mandatory.txt 168 - info on the Linux implementation of Sys V mandatory file locking. 169mca.txt 170 - info on supporting Micro Channel Architecture (e.g. PS/2) systems. 171md.txt 172 - info on boot arguments for the multiple devices driver. 173memory.txt 174 - info on typical Linux memory problems. 175mips/ 176 - directory with info about Linux on MIPS architecture. 177mono.txt 178 - how to execute Mono-based .NET binaries with the help of BINFMT_MISC. 179moxa-smartio 180 - info on installing/using Moxa multiport serial driver. 181mtrr.txt 182 - how to use PPro Memory Type Range Registers to increase performance. 183nbd.txt 184 - info on a TCP implementation of a network block device. 185netlabel/ 186 - directory with information on the NetLabel subsystem. 187networking/ 188 - directory with info on various aspects of networking with Linux. 189nfsroot.txt 190 - short guide on setting up a diskless box with NFS root filesystem. 191nmi_watchdog.txt 192 - info on NMI watchdog for SMP systems. 193numastat.txt 194 - info on how to read Numa policy hit/miss statistics in sysfs. 195oops-tracing.txt 196 - how to decode those nasty internal kernel error dump messages. 197paride.txt 198 - information about the parallel port IDE subsystem. 199parisc/ 200 - directory with info on using Linux on PA-RISC architecture. 201parport.txt 202 - how to use the parallel-port driver. 203parport-lowlevel.txt 204 - description and usage of the low level parallel port functions. 205pci.txt 206 - info on the PCI subsystem for device driver authors. 207pm.txt 208 - info on Linux power management support. 209pnp.txt 210 - Linux Plug and Play documentation. 211power/ 212 - directory with info on Linux PCI power management. 213powerpc/ 214 - directory with info on using Linux with the PowerPC. 215preempt-locking.txt 216 - info on locking under a preemptive kernel. 217ramdisk.txt 218 - short guide on how to set up and use the RAM disk. 219riscom8.txt 220 - notes on using the RISCom/8 multi-port serial driver. 221rocket.txt 222 - info on the Comtrol RocketPort multiport serial driver. 223rpc-cache.txt 224 - introduction to the caching mechanisms in the sunrpc layer. 225rtc.txt 226 - notes on how to use the Real Time Clock (aka CMOS clock) driver. 227s390/ 228 - directory with info on using Linux on the IBM S390. 229sched-coding.txt 230 - reference for various scheduler-related methods in the O(1) scheduler. 231sched-design.txt 232 - goals, design and implementation of the Linux O(1) scheduler. 233sched-domains.txt 234 - information on scheduling domains. 235sched-stats.txt 236 - information on schedstats (Linux Scheduler Statistics). 237scsi/ 238 - directory with info on Linux scsi support. 239serial/ 240 - directory with info on the low level serial API. 241serial-console.txt 242 - how to set up Linux with a serial line console as the default. 243sgi-visws.txt 244 - short blurb on the SGI Visual Workstations. 245sh/ 246 - directory with info on porting Linux to a new architecture. 247smart-config.txt 248 - description of the Smart Config makefile feature. 249smp.txt 250 - a few notes on symmetric multi-processing. 251sonypi.txt 252 - info on Linux Sony Programmable I/O Device support. 253sound/ 254 - directory with info on sound card support. 255sparc/ 256 - directory with info on using Linux on Sparc architecture. 257specialix.txt 258 - info on hardware/driver for specialix IO8+ multiport serial card. 259spinlocks.txt 260 - info on using spinlocks to provide exclusive access in kernel. 261stable_api_nonsense.txt 262 - info on why the kernel does not have a stable in-kernel api or abi. 263stable_kernel_rules.txt 264 - rules and procedures for the -stable kernel releases. 265stallion.txt 266 - info on using the Stallion multiport serial driver. 267svga.txt 268 - short guide on selecting video modes at boot via VGA BIOS. 269sx.txt 270 - info on the Specialix SX/SI multiport serial driver. 271sysctl/ 272 - directory with info on the /proc/sys/* files. 273sysrq.txt 274 - info on the magic SysRq key. 275telephony/ 276 - directory with info on telephony (e.g. voice over IP) support. 277time_interpolators.txt 278 - info on time interpolators. 279tipar.txt 280 - information about Parallel link cable for Texas Instruments handhelds. 281tty.txt 282 - guide to the locking policies of the tty layer. 283unicode.txt 284 - info on the Unicode character/font mapping used in Linux. 285uml/ 286 - directory with information about User Mode Linux. 287usb/ 288 - directory with info regarding the Universal Serial Bus. 289video4linux/ 290 - directory with info regarding video/TV/radio cards and linux. 291vm/ 292 - directory with info on the Linux vm code. 293voyager.txt 294 - guide to running Linux on the Voyager architecture. 295watchdog/ 296 - how to auto-reboot Linux if it has "fallen and can't get up". ;-) 297x86_64/ 298 - directory with info on Linux support for AMD x86-64 (Hammer) machines. 299xterm-linux.xpm 300 - XPM image of penguin logo (see logo.txt) sitting on an xterm. 301zorro.txt 302 - info on writing drivers for Zorro bus devices found on Amigas. 303