Documentation/00-INDEX

   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 (jf@listserv.linux.or.jp), at
  11      http://linuxjf.sourceforge.jp/
  12
  13 00-INDEX
  14         - this file.
  15 ABI/
  16         - info on kernel <-> userspace ABI and relative interface stability.
  17
  18 BUG-HUNTING
  19         - brute force method of doing binary search of patches to find bug.
  20 Changes
  21         - list of changes that break older software packages.
  22 CodingStyle
  23         - how the boss likes the C code in the kernel to look.
  24 development-process/
  25         - An extended tutorial on how to work with the kernel development
  26           process.
  27 DMA-API.txt
  28         - DMA API, pci_ API & extensions for non-consistent memory machines.
  29 DMA-ISA-LPC.txt
  30         - How to do DMA with ISA (and LPC) devices.
  31 DocBook/
  32         - directory with DocBook templates etc. for kernel documentation.
  33 HOWTO
  34         - the process and procedures of how to do Linux kernel development.
  35 IPMI.txt
  36         - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
  37 IRQ-affinity.txt
  38         - how to select which CPU(s) handle which interrupt events on SMP.
  39 IRQ.txt
  40         - description of what an IRQ is.
  41 ManagementStyle
  42         - how to (attempt to) manage kernel hackers.
  43 RCU/
  44         - directory with info on RCU (read-copy update).
  45 SAK.txt
  46         - info on Secure Attention Keys.
  47 SM501.txt
  48         - Silicon Motion SM501 multimedia companion chip
  49 SecurityBugs
  50         - procedure for reporting security bugs found in the kernel.
  51 SubmitChecklist
  52         - Linux kernel patch submission checklist.
  53 SubmittingDrivers
  54         - procedure to get a new driver source included into the kernel tree.
  55 SubmittingPatches
  56         - procedure to get a source patch included into the kernel tree.
  57 VGA-softcursor.txt
  58         - how to change your VGA cursor from a blinking underscore.
  59 accounting/
  60         - documentation on accounting and taskstats.
  61 acpi/
  62         - info on ACPI-specific hooks in the kernel.
  63 aoe/
  64         - description of AoE (ATA over Ethernet) along with config examples.
  65 applying-patches.txt
  66         - description of various trees and how to apply their patches.
  67 arm/
  68         - directory with info about Linux on the ARM architecture.
  69 atomic_ops.txt
  70         - semantics and behavior of atomic and bitmask operations.
  71 auxdisplay/
  72         - misc. LCD driver documentation (cfag12864b, ks0108).
  73 basic_profiling.txt
  74         - basic instructions for those who wants to profile Linux kernel.
  75 binfmt_misc.txt
  76         - info on the kernel support for extra binary formats.
  77 blackfin/
  78         - directory with documentation for the Blackfin arch.
  79 block/
  80         - info on the Block I/O (BIO) layer.
  81 blockdev/
  82         - info on block devices & drivers
  83 btmrvl.txt
  84         - info on Marvell Bluetooth driver usage.
  85 bus-virt-phys-mapping.txt
  86         - how to access I/O mapped memory from within device drivers.
  87 cachetlb.txt
  88         - describes the cache/TLB flushing interfaces Linux uses.
  89 cdrom/
  90         - directory with information on the CD-ROM drivers that Linux has.
  91 cgroups/
  92         - cgroups features, including cpusets and memory controller.
  93 connector/
  94         - docs on the netlink based userspace<->kernel space communication mod.
  95 console/
  96         - documentation on Linux console drivers.
  97 cpu-freq/
  98         - info on CPU frequency and voltage scaling.
  99 cpu-hotplug.txt
 100         - document describing CPU hotplug support in the Linux kernel.
 101 cpu-load.txt
 102         - document describing how CPU load statistics are collected.
 103 cpuidle/
 104         - info on CPU_IDLE, CPU idle state management subsystem.
 105 cputopology.txt
 106         - documentation on how CPU topology info is exported via sysfs.
 107 crc32.txt
 108         - brief tutorial on CRC computation
 109 cris/
 110         - directory with info about Linux on CRIS architecture.
 111 crypto/
 112         - directory with info on the Crypto API.
 113 dcdbas.txt
 114         - information on the Dell Systems Management Base Driver.
 115 debugging-modules.txt
 116         - some notes on debugging modules after Linux 2.6.3.
 117 dell_rbu.txt
 118         - document demonstrating the use of the Dell Remote BIOS Update driver.
 119 device-mapper/
 120         - directory with info on Device Mapper.
 121 devices.txt
 122         - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
 123 dontdiff
 124         - file containing a list of files that should never be diff'ed.
 125 driver-model/
 126         - directory with info about Linux driver model.
 127 dvb/
 128         - info on Linux Digital Video Broadcast (DVB) subsystem.
 129 early-userspace/
 130         - info about initramfs, klibc, and userspace early during boot.
 131 edac.txt
 132         - information on EDAC - Error Detection And Correction
 133 eisa.txt
 134         - info on EISA bus support.
 135 fault-injection/
 136         - dir with docs about the fault injection capabilities infrastructure.
 137 fb/
 138         - directory with info on the frame buffer graphics abstraction layer.
 139 feature-removal-schedule.txt
 140         - list of files and features that are going to be removed.
 141 filesystems/
 142         - info on the vfs and the various filesystems that Linux supports.
 143 firmware_class/
 144         - request_firmware() hotplug interface info.
 145 frv/
 146         - Fujitsu FR-V Linux documentation.
 147 gpio.txt
 148         - overview of GPIO (General Purpose Input/Output) access conventions.
 149 highuid.txt
 150         - notes on the change from 16 bit to 32 bit user/group IDs.
 151 timers/
 152         - info on the timer related topics
 153 hw_random.txt
 154         - info on Linux support for random number generator in i8xx chipsets.
 155 hwmon/
 156         - directory with docs on various hardware monitoring drivers.
 157 i2c/
 158         - directory with info about the I2C bus/protocol (2 wire, kHz speed).
 159 i2o/
 160         - directory with info about the Linux I2O subsystem.
 161 x86/i386/
 162         - directory with info about Linux on Intel 32 bit architecture.
 163 ia64/
 164         - directory with info about Linux on Intel 64 bit architecture.
 165 infiniband/
 166         - directory with documents concerning Linux InfiniBand support.
 167 initrd.txt
 168         - how to use the RAM disk as an initial/temporary root filesystem.
 169 input/
 170         - info on Linux input device support.
 171 io-mapping.txt
 172         - description of io_mapping functions in linux/io-mapping.h
 173 io_ordering.txt
 174         - info on ordering I/O writes to memory-mapped addresses.
 175 ioctl/
 176         - directory with documents describing various IOCTL calls.
 177 iostats.txt
 178         - info on I/O statistics Linux kernel provides.
 179 irqflags-tracing.txt
 180         - how to use the irq-flags tracing feature.
 181 isapnp.txt
 182         - info on Linux ISA Plug & Play support.
 183 isdn/
 184         - directory with info on the Linux ISDN support, and supported cards.
 185 java.txt
 186         - info on the in-kernel binary support for Java(tm).
 187 kbuild/
 188         - directory with info about the kernel build process.
 189 kdump/
 190         - directory with mini HowTo on getting the crash dump code to work.
 191 kernel-doc-nano-HOWTO.txt
 192         - mini HowTo on generation and location of kernel documentation files.
 193 kernel-docs.txt
 194         - listing of various WWW + books that document kernel internals.
 195 kernel-parameters.txt
 196         - summary listing of command line / boot prompt args for the kernel.
 197 kobject.txt
 198         - info of the kobject infrastructure of the Linux kernel.
 199 kprobes.txt
 200         - documents the kernel probes debugging feature.
 201 kref.txt
 202         - docs on adding reference counters (krefs) to kernel objects.
 203 laptops/
 204         - directory with laptop related info and laptop driver documentation.
 205 ldm.txt
 206         - a brief description of LDM (Windows Dynamic Disks).
 207 leds/
 208         - directory with info about LED handling under Linux.
 209 local_ops.txt
 210         - semantics and behavior of local atomic operations.
 211 lockdep-design.txt
 212         - documentation on the runtime locking correctness validator.
 213 lockup-watchdogs.txt
 214         - info on soft and hard lockup detectors (aka nmi_watchdog).
 215 logo.gif
 216         - full colour GIF image of Linux logo (penguin - Tux).
 217 logo.txt
 218         - info on creator of above logo & site to get additional images from.
 219 m68k/
 220         - directory with info about Linux on Motorola 68k architecture.
 221 magic-number.txt
 222         - list of magic numbers used to mark/protect kernel data structures.
 223 md.txt
 224         - info on boot arguments for the multiple devices driver.
 225 memory-barriers.txt
 226         - info on Linux kernel memory barriers.
 227 memory-hotplug.txt
 228         - Hotpluggable memory support, how to use and current status.
 229 memory.txt
 230         - info on typical Linux memory problems.
 231 mips/
 232         - directory with info about Linux on MIPS architecture.
 233 mmc/
 234         - directory with info about the MMC subsystem
 235 mono.txt
 236         - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
 237 mutex-design.txt
 238         - info on the generic mutex subsystem.
 239 namespaces/
 240         - directory with various information about namespaces
 241 netlabel/
 242         - directory with information on the NetLabel subsystem.
 243 networking/
 244         - directory with info on various aspects of networking with Linux.
 245 nommu-mmap.txt
 246         - documentation about no-mmu memory mapping support.
 247 numastat.txt
 248         - info on how to read Numa policy hit/miss statistics in sysfs.
 249 oops-tracing.txt
 250         - how to decode those nasty internal kernel error dump messages.
 251 padata.txt
 252         - An introduction to the "padata" parallel execution API
 253 parisc/
 254         - directory with info on using Linux on PA-RISC architecture.
 255 parport.txt
 256         - how to use the parallel-port driver.
 257 parport-lowlevel.txt
 258         - description and usage of the low level parallel port functions.
 259 pcmcia/
 260         - info on the Linux PCMCIA driver.
 261 pi-futex.txt
 262         - documentation on lightweight PI-futexes.
 263 pnp.txt
 264         - Linux Plug and Play documentation.
 265 power/
 266         - directory with info on Linux PCI power management.
 267 powerpc/
 268         - directory with info on using Linux with the PowerPC.
 269 preempt-locking.txt
 270         - info on locking under a preemptive kernel.
 271 printk-formats.txt
 272         - how to get printk format specifiers right
 273 ramoops.txt
 274         - documentation of the ramoops oops/panic logging module.
 275 rbtree.txt
 276         - info on what red-black trees are and what they are for.
 277 robust-futex-ABI.txt
 278         - documentation of the robust futex ABI.
 279 robust-futexes.txt
 280         - a description of what robust futexes are.
 281 rt-mutex-design.txt
 282         - description of the RealTime mutex implementation design.
 283 rt-mutex.txt
 284         - desc. of RT-mutex subsystem with PI (Priority Inheritance) support.
 285 rtc.txt
 286         - notes on how to use the Real Time Clock (aka CMOS clock) driver.
 287 s390/
 288         - directory with info on using Linux on the IBM S390.
 289 scheduler/
 290         - directory with info on the scheduler.
 291 scsi/
 292         - directory with info on Linux scsi support.
 293 security/
 294         - directory that contains security-related info
 295 serial/
 296         - directory with info on the low level serial API.
 297 serial-console.txt
 298         - how to set up Linux with a serial line console as the default.
 299 sgi-ioc4.txt
 300         - description of the SGI IOC4 PCI (multi function) device.
 301 sgi-visws.txt
 302         - short blurb on the SGI Visual Workstations.
 303 sh/
 304         - directory with info on porting Linux to a new architecture.
 305 sound/
 306         - directory with info on sound card support.
 307 sparc/
 308         - directory with info on using Linux on Sparc architecture.
 309 sparse.txt
 310         - info on how to obtain and use the sparse tool for typechecking.
 311 spi/
 312         - overview of Linux kernel Serial Peripheral Interface (SPI) support.
 313 spinlocks.txt
 314         - info on using spinlocks to provide exclusive access in kernel.
 315 stable_api_nonsense.txt
 316         - info on why the kernel does not have a stable in-kernel api or abi.
 317 stable_kernel_rules.txt
 318         - rules and procedures for the -stable kernel releases.
 319 svga.txt
 320         - short guide on selecting video modes at boot via VGA BIOS.
 321 sysfs-rules.txt
 322         - How not to use sysfs.
 323 sysctl/
 324         - directory with info on the /proc/sys/* files.
 325 sysrq.txt
 326         - info on the magic SysRq key.
 327 telephony/
 328         - directory with info on telephony (e.g. voice over IP) support.
 329 unicode.txt
 330         - info on the Unicode character/font mapping used in Linux.
 331 unshare.txt
 332         - description of the Linux unshare system call.
 333 usb/
 334         - directory with info regarding the Universal Serial Bus.
 335 video-output.txt
 336         - sysfs class driver interface to enable/disable a video output device.
 337 video4linux/
 338         - directory with info regarding video/TV/radio cards and linux.
 339 vm/
 340         - directory with info on the Linux vm code.
 341 volatile-considered-harmful.txt
 342         - Why the "volatile" type class should not be used
 343 w1/
 344         - directory with documents regarding the 1-wire (w1) subsystem.
 345 watchdog/
 346         - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
 347 x86/x86_64/
 348         - directory with info on Linux support for AMD x86-64 (Hammer) machines.
 349 zorro.txt
 350         - info on writing drivers for Zorro bus devices found on Amigas.