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@listserv.linux.or.jp), at 11 http://linuxjf.sourceforge.jp/ 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. 107crc32.txt 108 - brief tutorial on CRC computation 109cris/ 110 - directory with info about Linux on CRIS architecture. 111crypto/ 112 - directory with info on the Crypto API. 113dcdbas.txt 114 - information on the Dell Systems Management Base Driver. 115debugging-modules.txt 116 - some notes on debugging modules after Linux 2.6.3. 117dell_rbu.txt 118 - document demonstrating the use of the Dell Remote BIOS Update driver. 119device-mapper/ 120 - directory with info on Device Mapper. 121devices.txt 122 - plain ASCII listing of all the nodes in /dev/ with major minor #'s. 123dontdiff 124 - file containing a list of files that should never be diff'ed. 125driver-model/ 126 - directory with info about Linux driver model. 127dvb/ 128 - info on Linux Digital Video Broadcast (DVB) subsystem. 129early-userspace/ 130 - info about initramfs, klibc, and userspace early during boot. 131edac.txt 132 - information on EDAC - Error Detection And Correction 133eisa.txt 134 - info on EISA bus support. 135fault-injection/ 136 - dir with docs about the fault injection capabilities infrastructure. 137fb/ 138 - directory with info on the frame buffer graphics abstraction layer. 139feature-removal-schedule.txt 140 - list of files and features that are going to be removed. 141filesystems/ 142 - info on the vfs and the various filesystems that Linux supports. 143firmware_class/ 144 - request_firmware() hotplug interface info. 145frv/ 146 - Fujitsu FR-V Linux documentation. 147gpio.txt 148 - overview of GPIO (General Purpose Input/Output) access conventions. 149highuid.txt 150 - notes on the change from 16 bit to 32 bit user/group IDs. 151timers/ 152 - info on the timer related topics 153hw_random.txt 154 - info on Linux support for random number generator in i8xx chipsets. 155hwmon/ 156 - directory with docs on various hardware monitoring drivers. 157i2c/ 158 - directory with info about the I2C bus/protocol (2 wire, kHz speed). 159i2o/ 160 - directory with info about the Linux I2O subsystem. 161x86/i386/ 162 - directory with info about Linux on Intel 32 bit architecture. 163ia64/ 164 - directory with info about Linux on Intel 64 bit architecture. 165infiniband/ 166 - directory with documents concerning Linux InfiniBand support. 167initrd.txt 168 - how to use the RAM disk as an initial/temporary root filesystem. 169input/ 170 - info on Linux input device support. 171io-mapping.txt 172 - description of io_mapping functions in linux/io-mapping.h 173io_ordering.txt 174 - info on ordering I/O writes to memory-mapped addresses. 175ioctl/ 176 - directory with documents describing various IOCTL calls. 177iostats.txt 178 - info on I/O statistics Linux kernel provides. 179irqflags-tracing.txt 180 - how to use the irq-flags tracing feature. 181isapnp.txt 182 - info on Linux ISA Plug & Play support. 183isdn/ 184 - directory with info on the Linux ISDN support, and supported cards. 185java.txt 186 - info on the in-kernel binary support for Java(tm). 187kbuild/ 188 - directory with info about the kernel build process. 189kdump/ 190 - directory with mini HowTo on getting the crash dump code to work. 191kernel-doc-nano-HOWTO.txt 192 - mini HowTo on generation and location of kernel documentation files. 193kernel-docs.txt 194 - listing of various WWW + books that document kernel internals. 195kernel-parameters.txt 196 - summary listing of command line / boot prompt args for the kernel. 197kobject.txt 198 - info of the kobject infrastructure of the Linux kernel. 199kprobes.txt 200 - documents the kernel probes debugging feature. 201kref.txt 202 - docs on adding reference counters (krefs) to kernel objects. 203laptops/ 204 - directory with laptop related info and laptop driver documentation. 205ldm.txt 206 - a brief description of LDM (Windows Dynamic Disks). 207leds/ 208 - directory with info about LED handling under Linux. 209local_ops.txt 210 - semantics and behavior of local atomic operations. 211lockdep-design.txt 212 - documentation on the runtime locking correctness validator. 213logo.gif 214 - full colour GIF image of Linux logo (penguin - Tux). 215logo.txt 216 - info on creator of above logo & site to get additional images from. 217m68k/ 218 - directory with info about Linux on Motorola 68k architecture. 219magic-number.txt 220 - list of magic numbers used to mark/protect kernel data structures. 221mca.txt 222 - info on supporting Micro Channel Architecture (e.g. PS/2) systems. 223md.txt 224 - info on boot arguments for the multiple devices driver. 225memory-barriers.txt 226 - info on Linux kernel memory barriers. 227memory-hotplug.txt 228 - Hotpluggable memory support, how to use and current status. 229memory.txt 230 - info on typical Linux memory problems. 231mips/ 232 - directory with info about Linux on MIPS architecture. 233mmc/ 234 - directory with info about the MMC subsystem 235mono.txt 236 - how to execute Mono-based .NET binaries with the help of BINFMT_MISC. 237mutex-design.txt 238 - info on the generic mutex subsystem. 239namespaces/ 240 - directory with various information about namespaces 241netlabel/ 242 - directory with information on the NetLabel subsystem. 243networking/ 244 - directory with info on various aspects of networking with Linux. 245nmi_watchdog.txt 246 - info on NMI watchdog for SMP systems. 247nommu-mmap.txt 248 - documentation about no-mmu memory mapping support. 249numastat.txt 250 - info on how to read Numa policy hit/miss statistics in sysfs. 251oops-tracing.txt 252 - how to decode those nasty internal kernel error dump messages. 253padata.txt 254 - An introduction to the "padata" parallel execution API 255parisc/ 256 - directory with info on using Linux on PA-RISC architecture. 257parport.txt 258 - how to use the parallel-port driver. 259parport-lowlevel.txt 260 - description and usage of the low level parallel port functions. 261pcmcia/ 262 - info on the Linux PCMCIA driver. 263pi-futex.txt 264 - documentation on lightweight PI-futexes. 265pnp.txt 266 - Linux Plug and Play documentation. 267power/ 268 - directory with info on Linux PCI power management. 269powerpc/ 270 - directory with info on using Linux with the PowerPC. 271preempt-locking.txt 272 - info on locking under a preemptive kernel. 273printk-formats.txt 274 - how to get printk format specifiers right 275prio_tree.txt 276 - info on radix-priority-search-tree use for indexing vmas. 277ramoops.txt 278 - documentation of the ramoops oops/panic logging module. 279rbtree.txt 280 - info on what red-black trees are and what they are for. 281robust-futex-ABI.txt 282 - documentation of the robust futex ABI. 283robust-futexes.txt 284 - a description of what robust futexes are. 285rt-mutex-design.txt 286 - description of the RealTime mutex implementation design. 287rt-mutex.txt 288 - desc. of RT-mutex subsystem with PI (Priority Inheritance) support. 289rtc.txt 290 - notes on how to use the Real Time Clock (aka CMOS clock) driver. 291s390/ 292 - directory with info on using Linux on the IBM S390. 293scheduler/ 294 - directory with info on the scheduler. 295scsi/ 296 - directory with info on Linux scsi support. 297security/ 298 - directory that contains security-related info 299serial/ 300 - directory with info on the low level serial API. 301serial-console.txt 302 - how to set up Linux with a serial line console as the default. 303sgi-ioc4.txt 304 - description of the SGI IOC4 PCI (multi function) device. 305sgi-visws.txt 306 - short blurb on the SGI Visual Workstations. 307sh/ 308 - directory with info on porting Linux to a new architecture. 309sound/ 310 - directory with info on sound card support. 311sparc/ 312 - directory with info on using Linux on Sparc architecture. 313sparse.txt 314 - info on how to obtain and use the sparse tool for typechecking. 315spi/ 316 - overview of Linux kernel Serial Peripheral Interface (SPI) support. 317spinlocks.txt 318 - info on using spinlocks to provide exclusive access in kernel. 319stable_api_nonsense.txt 320 - info on why the kernel does not have a stable in-kernel api or abi. 321stable_kernel_rules.txt 322 - rules and procedures for the -stable kernel releases. 323svga.txt 324 - short guide on selecting video modes at boot via VGA BIOS. 325sysfs-rules.txt 326 - How not to use sysfs. 327sysctl/ 328 - directory with info on the /proc/sys/* files. 329sysrq.txt 330 - info on the magic SysRq key. 331telephony/ 332 - directory with info on telephony (e.g. voice over IP) support. 333unicode.txt 334 - info on the Unicode character/font mapping used in Linux. 335unshare.txt 336 - description of the Linux unshare system call. 337usb/ 338 - directory with info regarding the Universal Serial Bus. 339video-output.txt 340 - sysfs class driver interface to enable/disable a video output device. 341video4linux/ 342 - directory with info regarding video/TV/radio cards and linux. 343vm/ 344 - directory with info on the Linux vm code. 345volatile-considered-harmful.txt 346 - Why the "volatile" type class should not be used 347w1/ 348 - directory with documents regarding the 1-wire (w1) subsystem. 349watchdog/ 350 - how to auto-reboot Linux if it has "fallen and can't get up". ;-) 351x86/x86_64/ 352 - directory with info on Linux support for AMD x86-64 (Hammer) machines. 353zorro.txt 354 - info on writing drivers for Zorro bus devices found on Amigas. 355
