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