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@linux.or.jp), at
  11      http://www.linux.or.jp/JF/
  12
  13 00-INDEX
  14         - this file.
  15 ABI/
  16         - info on kernel <-> userspace ABI and relative interface stability.
  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-ISA-LPC.txt
  26         - How to do DMA with ISA (and LPC) devices.
  27 DMA-mapping.txt
  28         - info for PCI drivers using DMA portably across all platforms.
  29 DocBook/
  30         - directory with DocBook templates etc. for kernel documentation.
  31 HOWTO
  32         - the process and procedures of how to do Linux kernel development.
  33 IO-mapping.txt
  34         - how to access I/O mapped memory from within device drivers.
  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 MSI-HOWTO.txt
  44         - the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ.
  45 PCIEBUS-HOWTO.txt
  46         - a guide describing the PCI Express Port Bus driver.
  47 RCU/
  48         - directory with info on RCU (read-copy update).
  49 README.DAC960
  50         - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux.
  51 README.cycladesZ
  52         - info on Cyclades-Z firmware loading.
  53 SAK.txt
  54         - info on Secure Attention Keys.
  55 SM501.txt
  56         - Silicon Motion SM501 multimedia companion chip
  57 SecurityBugs
  58         - procedure for reporting security bugs found in the kernel.
  59 SubmitChecklist
  60         - Linux kernel patch submission checklist.
  61 SubmittingDrivers
  62         - procedure to get a new driver source included into the kernel tree.
  63 SubmittingPatches
  64         - procedure to get a source patch included into the kernel tree.
  65 VGA-softcursor.txt
  66         - how to change your VGA cursor from a blinking underscore.
  67 accounting/
  68         - documentation on accounting and taskstats.
  69 aoe/
  70         - description of AoE (ATA over Ethernet) along with config examples.
  71 applying-patches.txt
  72         - description of various trees and how to apply their patches.
  73 arm/
  74         - directory with info about Linux on the ARM architecture.
  75 atomic_ops.txt
  76         - semantics and behavior of atomic and bitmask operations.
  77 auxdisplay/
  78         - misc. LCD driver documentation (cfag12864b, ks0108).
  79 basic_profiling.txt
  80         - basic instructions for those who wants to profile Linux kernel.
  81 binfmt_misc.txt
  82         - info on the kernel support for extra binary formats.
  83 blackfin/
  84         - directory with documentation for the Blackfin arch.
  85 block/
  86         - info on the Block I/O (BIO) layer.
  87 cachetlb.txt
  88         - describes the cache/TLB flushing interfaces Linux uses.
  89 cciss.txt
  90         - info, major/minor #'s for Compaq's SMART Array Controllers.
  91 cdrom/
  92         - directory with information on the CD-ROM drivers that Linux has.
  93 cli-sti-removal.txt
  94         - cli()/sti() removal guide.
  95 computone.txt
  96         - info on Computone Intelliport II/Plus Multiport Serial Driver.
  97 connector/
  98         - docs on the netlink based userspace<->kernel space communication mod.
  99 console/
 100         - documentation on Linux console drivers.
 101 cpqarray.txt
 102         - info on using Compaq's SMART2 Intelligent Disk Array Controllers.
 103 cpu-freq/
 104         - info on CPU frequency and voltage scaling.
 105 cpu-hotplug.txt
 106         - document describing CPU hotplug support in the Linux kernel.
 107 cpu-load.txt
 108         - document describing how CPU load statistics are collected.
 109 cpusets.txt
 110         - documents the cpusets feature; assign CPUs and Mem to a set of tasks.
 111 cputopology.txt
 112         - documentation on how CPU topology info is exported via sysfs.
 113 cris/
 114         - directory with info about Linux on CRIS architecture.
 115 crypto/
 116         - directory with info on the Crypto API.
 117 dcdbas.txt
 118         - information on the Dell Systems Management Base Driver.
 119 debugging-modules.txt
 120         - some notes on debugging modules after Linux 2.6.3.
 121 dell_rbu.txt
 122         - document demonstrating the use of the Dell Remote BIOS Update driver.
 123 device-mapper/
 124         - directory with info on Device Mapper.
 125 devices.txt
 126         - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
 127 digiepca.txt
 128         - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
 129 dnotify.txt
 130         - info about directory notification in Linux.
 131 dontdiff
 132         - file containing a list of files that should never be diff'ed.
 133 driver-model/
 134         - directory with info about Linux driver model.
 135 drivers/
 136         - directory with driver documentation (currently only EDAC).
 137 dvb/
 138         - info on Linux Digital Video Broadcast (DVB) subsystem.
 139 early-userspace/
 140         - info about initramfs, klibc, and userspace early during boot.
 141 eisa.txt
 142         - info on EISA bus support.
 143 exception.txt
 144         - how Linux v2.2 handles exceptions without verify_area etc.
 145 fault-injection/
 146         - dir with docs about the fault injection capabilities infrastructure.
 147 fb/
 148         - directory with info on the frame buffer graphics abstraction layer.
 149 feature-removal-schedule.txt
 150         - list of files and features that are going to be removed.
 151 filesystems/
 152         - info on the vfs and the various filesystems that Linux supports.
 153 firmware_class/
 154         - request_firmware() hotplug interface info.
 155 floppy.txt
 156         - notes and driver options for the floppy disk driver.
 157 frv/
 158         - Fujitsu FR-V Linux documentation.
 159 gpio.txt
 160         - overview of GPIO (General Purpose Input/Output) access conventions.
 161 hayes-esp.txt
 162         - info on using the Hayes ESP serial driver.
 163 highuid.txt
 164         - notes on the change from 16 bit to 32 bit user/group IDs.
 165 hpet.txt
 166         - High Precision Event Timer Driver for Linux.
 167 hrtimer/
 168         - info on the timer_stats debugging facility for timer (ab)use.
 169 hrtimers/
 170         - info on the hrtimers subsystem for high-resolution kernel timers.
 171 hw_random.txt
 172         - info on Linux support for random number generator in i8xx chipsets.
 173 hwmon/
 174         - directory with docs on various hardware monitoring drivers.
 175 i2c/
 176         - directory with info about the I2C bus/protocol (2 wire, kHz speed).
 177 i2o/
 178         - directory with info about the Linux I2O subsystem.
 179 i386/
 180         - directory with info about Linux on Intel 32 bit architecture.
 181 ia64/
 182         - directory with info about Linux on Intel 64 bit architecture.
 183 ide.txt
 184         - important info for users of ATA devices (IDE/EIDE disks and CD-ROMS).
 185 infiniband/
 186         - directory with documents concerning Linux InfiniBand support.
 187 initrd.txt
 188         - how to use the RAM disk as an initial/temporary root filesystem.
 189 input/
 190         - info on Linux input device support.
 191 io_ordering.txt
 192         - info on ordering I/O writes to memory-mapped addresses.
 193 ioctl/
 194         - directory with documents describing various IOCTL calls.
 195 ioctl-number.txt
 196         - how to implement and register device/driver ioctl calls.
 197 iostats.txt
 198         - info on I/O statistics Linux kernel provides.
 199 irqflags-tracing.txt
 200         - how to use the irq-flags tracing feature.
 201 isapnp.txt
 202         - info on Linux ISA Plug & Play support.
 203 isdn/
 204         - directory with info on the Linux ISDN support, and supported cards.
 205 java.txt
 206         - info on the in-kernel binary support for Java(tm).
 207 kbuild/
 208         - directory with info about the kernel build process.
 209 kdump/
 210         - directory with mini HowTo on getting the crash dump code to work.
 211 kernel-doc-nano-HOWTO.txt
 212         - mini HowTo on generation and location of kernel documentation files.
 213 kernel-docs.txt
 214         - listing of various WWW + books that document kernel internals.
 215 kernel-parameters.txt
 216         - summary listing of command line / boot prompt args for the kernel.
 217 keys-request-key.txt
 218         - description of the kernel key request service.
 219 keys.txt
 220         - description of the kernel key retention service.
 221 kobject.txt
 222         - info of the kobject infrastructure of the Linux kernel.
 223 kprobes.txt
 224         - documents the kernel probes debugging feature.
 225 kref.txt
 226         - docs on adding reference counters (krefs) to kernel objects.
 227 laptop-mode.txt
 228         - how to conserve battery power using laptop-mode.
 229 ldm.txt
 230         - a brief description of LDM (Windows Dynamic Disks).
 231 leds-class.txt
 232         - documents LED handling under Linux.
 233 local_ops.txt
 234         - semantics and behavior of local atomic operations.
 235 lockdep-design.txt
 236         - documentation on the runtime locking correctness validator.
 237 logo.gif
 238         - full colour GIF image of Linux logo (penguin - Tux).
 239 logo.txt
 240         - info on creator of above logo & site to get additional images from.
 241 m68k/
 242         - directory with info about Linux on Motorola 68k architecture.
 243 magic-number.txt
 244         - list of magic numbers used to mark/protect kernel data structures.
 245 mca.txt
 246         - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
 247 md.txt
 248         - info on boot arguments for the multiple devices driver.
 249 memory-barriers.txt
 250         - info on Linux kernel memory barriers.
 251 memory-hotplug.txt
 252         - Hotpluggable memory support, how to use and current status.
 253 memory.txt
 254         - info on typical Linux memory problems.
 255 mips/
 256         - directory with info about Linux on MIPS architecture.
 257 mono.txt
 258         - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
 259 moxa-smartio
 260         - file with info on installing/using Moxa multiport serial driver.
 261 mtrr.txt
 262         - how to use PPro Memory Type Range Registers to increase performance.
 263 mutex-design.txt
 264         - info on the generic mutex subsystem.
 265 namespaces/
 266         - directory with various information about namespaces
 267 nbd.txt
 268         - info on a TCP implementation of a network block device.
 269 netlabel/
 270         - directory with information on the NetLabel subsystem.
 271 networking/
 272         - directory with info on various aspects of networking with Linux.
 273 nfsroot.txt
 274         - short guide on setting up a diskless box with NFS root filesystem.
 275 nmi_watchdog.txt
 276         - info on NMI watchdog for SMP systems.
 277 nommu-mmap.txt
 278         - documentation about no-mmu memory mapping support.
 279 numastat.txt
 280         - info on how to read Numa policy hit/miss statistics in sysfs.
 281 oops-tracing.txt
 282         - how to decode those nasty internal kernel error dump messages.
 283 paride.txt
 284         - information about the parallel port IDE subsystem.
 285 parisc/
 286         - directory with info on using Linux on PA-RISC architecture.
 287 parport.txt
 288         - how to use the parallel-port driver.
 289 parport-lowlevel.txt
 290         - description and usage of the low level parallel port functions.
 291 pci-error-recovery.txt
 292         - info on PCI error recovery.
 293 pci.txt
 294         - info on the PCI subsystem for device driver authors.
 295 pcieaer-howto.txt
 296         - the PCI Express Advanced Error Reporting Driver Guide HOWTO.
 297 pcmcia/
 298         - info on the Linux PCMCIA driver.
 299 pi-futex.txt
 300         - documentation on lightweight PI-futexes.
 301 pm.txt
 302         - info on Linux power management support.
 303 pnp.txt
 304         - Linux Plug and Play documentation.
 305 power_supply_class.txt
 306         - Tells userspace about battery, UPS, AC or DC power supply properties
 307 power/
 308         - directory with info on Linux PCI power management.
 309 powerpc/
 310         - directory with info on using Linux with the PowerPC.
 311 preempt-locking.txt
 312         - info on locking under a preemptive kernel.
 313 prio_tree.txt
 314         - info on radix-priority-search-tree use for indexing vmas.
 315 ramdisk.txt
 316         - short guide on how to set up and use the RAM disk.
 317 rbtree.txt
 318         - info on what red-black trees are and what they are for.
 319 riscom8.txt
 320         - notes on using the RISCom/8 multi-port serial driver.
 321 robust-futex-ABI.txt
 322         - documentation of the robust futex ABI.
 323 robust-futexes.txt
 324         - a description of what robust futexes are.
 325 rocket.txt
 326         - info on the Comtrol RocketPort multiport serial driver.
 327 rpc-cache.txt
 328         - introduction to the caching mechanisms in the sunrpc layer.
 329 rt-mutex-design.txt
 330         - description of the RealTime mutex implementation design.
 331 rt-mutex.txt
 332         - desc. of RT-mutex subsystem with PI (Priority Inheritance) support.
 333 rtc.txt
 334         - notes on how to use the Real Time Clock (aka CMOS clock) driver.
 335 s390/
 336         - directory with info on using Linux on the IBM S390.
 337 sched-arch.txt
 338         - CPU Scheduler implementation hints for architecture specific code.
 339 sched-coding.txt
 340         - reference for various scheduler-related methods in the O(1) scheduler.
 341 sched-design.txt
 342         - goals, design and implementation of the Linux O(1) scheduler.
 343 sched-design-CFS.txt
 344         - goals, design and implementation of the Complete Fair Scheduler.
 345 sched-domains.txt
 346         - information on scheduling domains.
 347 sched-nice-design.txt
 348         - How and why the scheduler's nice levels are implemented.
 349 sched-stats.txt
 350         - information on schedstats (Linux Scheduler Statistics).
 351 scsi/
 352         - directory with info on Linux scsi support.
 353 serial/
 354         - directory with info on the low level serial API.
 355 serial-console.txt
 356         - how to set up Linux with a serial line console as the default.
 357 sgi-ioc4.txt
 358         - description of the SGI IOC4 PCI (multi function) device.
 359 sgi-visws.txt
 360         - short blurb on the SGI Visual Workstations.
 361 sh/
 362         - directory with info on porting Linux to a new architecture.
 363 sharedsubtree.txt
 364         - a description of shared subtrees for namespaces.
 365 smart-config.txt
 366         - description of the Smart Config makefile feature.
 367 sony-laptop.txt
 368         - Sony Notebook Control Driver (SNC) Readme.
 369 sonypi.txt
 370         - info on Linux Sony Programmable I/O Device support.
 371 sound/
 372         - directory with info on sound card support.
 373 sparc/
 374         - directory with info on using Linux on Sparc architecture.
 375 sparse.txt
 376         - info on how to obtain and use the sparse tool for typechecking.
 377 specialix.txt
 378         - info on hardware/driver for specialix IO8+ multiport serial card.
 379 spi/
 380         - overview of Linux kernel Serial Peripheral Interface (SPI) support.
 381 spinlocks.txt
 382         - info on using spinlocks to provide exclusive access in kernel.
 383 stable_api_nonsense.txt
 384         - info on why the kernel does not have a stable in-kernel api or abi.
 385 stable_kernel_rules.txt
 386         - rules and procedures for the -stable kernel releases.
 387 stallion.txt
 388         - info on using the Stallion multiport serial driver.
 389 svga.txt
 390         - short guide on selecting video modes at boot via VGA BIOS.
 391 sysfs-rules.txt
 392         - How not to use sysfs.
 393 sx.txt
 394         - info on the Specialix SX/SI multiport serial driver.
 395 sysctl/
 396         - directory with info on the /proc/sys/* files.
 397 sysrq.txt
 398         - info on the magic SysRq key.
 399 telephony/
 400         - directory with info on telephony (e.g. voice over IP) support.
 401 thinkpad-acpi.txt
 402         - information on the (IBM and Lenovo) ThinkPad ACPI Extras driver.
 403 time_interpolators.txt
 404         - info on time interpolators.
 405 tipar.txt
 406         - information about Parallel link cable for Texas Instruments handhelds.
 407 tty.txt
 408         - guide to the locking policies of the tty layer.
 409 uml/
 410         - directory with information about User Mode Linux.
 411 unicode.txt
 412         - info on the Unicode character/font mapping used in Linux.
 413 unshare.txt
 414         - description of the Linux unshare system call.
 415 usb/
 416         - directory with info regarding the Universal Serial Bus.
 417 video-output.txt
 418         - sysfs class driver interface to enable/disable a video output device.
 419 video4linux/
 420         - directory with info regarding video/TV/radio cards and linux.
 421 vm/
 422         - directory with info on the Linux vm code.
 423 volatile-considered-harmful.txt
 424         - Why the "volatile" type class should not be used
 425 voyager.txt
 426         - guide to running Linux on the Voyager architecture.
 427 w1/
 428         - directory with documents regarding the 1-wire (w1) subsystem.
 429 watchdog/
 430         - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
 431 x86_64/
 432         - directory with info on Linux support for AMD x86-64 (Hammer) machines.
 433 zorro.txt
 434         - info on writing drivers for Zorro bus devices found on Amigas.