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 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 maintainers expect the C code in the kernel to look.
  24 DMA-API.txt
  25         - DMA API, pci_ API & extensions for non-consistent memory machines.
  26 DMA-API-HOWTO.txt
  27         - Dynamic DMA mapping Guide
  28 DMA-ISA-LPC.txt
  29         - How to do DMA with ISA (and LPC) devices.
  30 DMA-attributes.txt
  31         - listing of the various possible attributes a DMA region can have
  32 dmatest.txt
  33         - how to compile, configure and use the dmatest system.
  34 DocBook/
  35         - directory with DocBook templates etc. for kernel documentation.
  36 EDID/
  37         - directory with info on customizing EDID for broken gfx/displays.
  38 HOWTO
  39         - the process and procedures of how to do Linux kernel development.
  40 IPMI.txt
  41         - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
  42 IRQ-affinity.txt
  43         - how to select which CPU(s) handle which interrupt events on SMP.
  44 IRQ-domain.txt
  45         - info on interrupt numbering and setting up IRQ domains.
  46 IRQ.txt
  47         - description of what an IRQ is.
  48 Intel-IOMMU.txt
  49         - basic info on the Intel IOMMU virtualization support.
  50 Makefile
  51         - some files in Documentation dir are actually sample code to build
  52 ManagementStyle
  53         - how to (attempt to) manage kernel hackers.
  54 RCU/
  55         - directory with info on RCU (read-copy update).
  56 SAK.txt
  57         - info on Secure Attention Keys.
  58 SM501.txt
  59         - Silicon Motion SM501 multimedia companion chip
  60 SecurityBugs
  61         - procedure for reporting security bugs found in the kernel.
  62 SubmitChecklist
  63         - Linux kernel patch submission checklist.
  64 SubmittingDrivers
  65         - procedure to get a new driver source included into the kernel tree.
  66 SubmittingPatches
  67         - procedure to get a source patch included into the kernel tree.
  68 VGA-softcursor.txt
  69         - how to change your VGA cursor from a blinking underscore.
  70 accounting/
  71         - documentation on accounting and taskstats.
  72 acpi/
  73         - info on ACPI-specific hooks in the kernel.
  74 aoe/
  75         - description of AoE (ATA over Ethernet) along with config examples.
  76 applying-patches.txt
  77         - description of various trees and how to apply their patches.
  78 arm/
  79         - directory with info about Linux on the ARM architecture.
  80 arm64/
  81         - directory with info about Linux on the 64 bit ARM architecture.
  82 assoc_array.txt
  83         - generic associative array intro.
  84 atomic_ops.txt
  85         - semantics and behavior of atomic and bitmask operations.
  86 auxdisplay/
  87         - misc. LCD driver documentation (cfag12864b, ks0108).
  88 backlight/
  89         - directory with info on controlling backlights in flat panel displays
  90 bad_memory.txt
  91         - how to use kernel parameters to exclude bad RAM regions.
  92 basic_profiling.txt
  93         - basic instructions for those who wants to profile Linux kernel.
  94 bcache.txt
  95         - Block-layer cache on fast SSDs to improve slow (raid) I/O performance.
  96 binfmt_misc.txt
  97         - info on the kernel support for extra binary formats.
  98 blackfin/
  99         - directory with documentation for the Blackfin arch.
 100 block/
 101         - info on the Block I/O (BIO) layer.
 102 blockdev/
 103         - info on block devices & drivers
 104 braille-console.txt
 105         - info on how to use serial devices for Braille support.
 106 bt8xxgpio.txt
 107         - info on how to modify a bt8xx video card for GPIO usage.
 108 btmrvl.txt
 109         - info on Marvell Bluetooth driver usage.
 110 bus-devices/
 111         - directory with info on TI GPMC (General Purpose Memory Controller)
 112 bus-virt-phys-mapping.txt
 113         - how to access I/O mapped memory from within device drivers.
 114 cachetlb.txt
 115         - describes the cache/TLB flushing interfaces Linux uses.
 116 cdrom/
 117         - directory with information on the CD-ROM drivers that Linux has.
 118 cgroups/
 119         - cgroups features, including cpusets and memory controller.
 120 circular-buffers.txt
 121         - how to make use of the existing circular buffer infrastructure
 122 clk.txt
 123         - info on the common clock framework
 124 coccinelle.txt
 125         - info on how to get and use the Coccinelle code checking tool.
 126 connector/
 127         - docs on the netlink based userspace<->kernel space communication mod.
 128 console/
 129         - documentation on Linux console drivers.
 130 cpu-freq/
 131         - info on CPU frequency and voltage scaling.
 132 cpu-hotplug.txt
 133         - document describing CPU hotplug support in the Linux kernel.
 134 cpu-load.txt
 135         - document describing how CPU load statistics are collected.
 136 cpuidle/
 137         - info on CPU_IDLE, CPU idle state management subsystem.
 138 cputopology.txt
 139         - documentation on how CPU topology info is exported via sysfs.
 140 crc32.txt
 141         - brief tutorial on CRC computation
 142 cris/
 143         - directory with info about Linux on CRIS architecture.
 144 crypto/
 145         - directory with info on the Crypto API.
 146 dcdbas.txt
 147         - information on the Dell Systems Management Base Driver.
 148 debugging-modules.txt
 149         - some notes on debugging modules after Linux 2.6.3.
 150 debugging-via-ohci1394.txt
 151         - how to use firewire like a hardware debugger memory reader.
 152 dell_rbu.txt
 153         - document demonstrating the use of the Dell Remote BIOS Update driver.
 154 development-process/
 155         - how to work with the mainline kernel development process.
 156 device-mapper/
 157         - directory with info on Device Mapper.
 158 devices.txt
 159         - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
 160 devicetree/
 161         - directory with info on device tree files used by OF/PowerPC/ARM
 162 digsig.txt
 163         -info on the Digital Signature Verification API
 164 dma-buf-sharing.txt
 165         - the DMA Buffer Sharing API Guide
 166 dmaengine.txt
 167         -the DMA Engine API Guide
 168 dontdiff
 169         - file containing a list of files that should never be diff'ed.
 170 driver-model/
 171         - directory with info about Linux driver model.
 172 dvb/
 173         - info on Linux Digital Video Broadcast (DVB) subsystem.
 174 dynamic-debug-howto.txt
 175         - how to use the dynamic debug (dyndbg) feature.
 176 early-userspace/
 177         - info about initramfs, klibc, and userspace early during boot.
 178 edac.txt
 179         - information on EDAC - Error Detection And Correction
 180 efi-stub.txt
 181         - How to use the EFI boot stub to bypass GRUB or elilo on EFI systems.
 182 eisa.txt
 183         - info on EISA bus support.
 184 email-clients.txt
 185         - info on how to use e-mail to send un-mangled (git) patches.
 186 extcon/
 187         - directory with porting guide for Android kernel switch driver.
 188 fault-injection/
 189         - dir with docs about the fault injection capabilities infrastructure.
 190 fb/
 191         - directory with info on the frame buffer graphics abstraction layer.
 192 filesystems/
 193         - info on the vfs and the various filesystems that Linux supports.
 194 firmware_class/
 195         - request_firmware() hotplug interface info.
 196 flexible-arrays.txt
 197         - how to make use of flexible sized arrays in linux
 198 fmc/
 199         - information about the FMC bus abstraction
 200 frv/
 201         - Fujitsu FR-V Linux documentation.
 202 futex-requeue-pi.txt
 203         - info on requeueing of tasks from a non-PI futex to a PI futex
 204 gcov.txt
 205         - use of GCC's coverage testing tool "gcov" with the Linux kernel
 206 gpio/
 207         - gpio related documentation
 208 hid/
 209         - directory with information on human interface devices
 210 highuid.txt
 211         - notes on the change from 16 bit to 32 bit user/group IDs.
 212 hwspinlock.txt
 213         - hardware spinlock provides hardware assistance for synchronization
 214 timers/
 215         - info on the timer related topics
 216 hw_random.txt
 217         - info on Linux support for random number generator in i8xx chipsets.
 218 hwmon/
 219         - directory with docs on various hardware monitoring drivers.
 220 i2c/
 221         - directory with info about the I2C bus/protocol (2 wire, kHz speed).
 222 i2o/
 223         - directory with info about the Linux I2O subsystem.
 224 x86/i386/
 225         - directory with info about Linux on Intel 32 bit architecture.
 226 ia64/
 227         - directory with info about Linux on Intel 64 bit architecture.
 228 infiniband/
 229         - directory with documents concerning Linux InfiniBand support.
 230 init.txt
 231         - what to do when the kernel can't find the 1st process to run.
 232 initrd.txt
 233         - how to use the RAM disk as an initial/temporary root filesystem.
 234 input/
 235         - info on Linux input device support.
 236 intel_txt.txt
 237         - info on intel Trusted Execution Technology (intel TXT).
 238 io-mapping.txt
 239         - description of io_mapping functions in linux/io-mapping.h
 240 io_ordering.txt
 241         - info on ordering I/O writes to memory-mapped addresses.
 242 ioctl/
 243         - directory with documents describing various IOCTL calls.
 244 iostats.txt
 245         - info on I/O statistics Linux kernel provides.
 246 irqflags-tracing.txt
 247         - how to use the irq-flags tracing feature.
 248 isapnp.txt
 249         - info on Linux ISA Plug & Play support.
 250 isdn/
 251         - directory with info on the Linux ISDN support, and supported cards.
 252 java.txt
 253         - info on the in-kernel binary support for Java(tm).
 254 ja_JP/
 255         - directory with Japanese translations of various documents
 256 kbuild/
 257         - directory with info about the kernel build process.
 258 kdump/
 259         - directory with mini HowTo on getting the crash dump code to work.
 260 kernel-doc-nano-HOWTO.txt
 261         - mini HowTo on generation and location of kernel documentation files.
 262 kernel-docs.txt
 263         - listing of various WWW + books that document kernel internals.
 264 kernel-parameters.txt
 265         - summary listing of command line / boot prompt args for the kernel.
 266 kernel-per-CPU-kthreads.txt
 267         - List of all per-CPU kthreads and how they introduce jitter.
 268 kmemcheck.txt
 269         - info on dynamic checker that detects uses of uninitialized memory.
 270 kmemleak.txt
 271         - info on how to make use of the kernel memory leak detection system
 272 ko_KR/
 273         - directory with Korean translations of various documents
 274 kobject.txt
 275         - info of the kobject infrastructure of the Linux kernel.
 276 kprobes.txt
 277         - documents the kernel probes debugging feature.
 278 kref.txt
 279         - docs on adding reference counters (krefs) to kernel objects.
 280 laptops/
 281         - directory with laptop related info and laptop driver documentation.
 282 ldm.txt
 283         - a brief description of LDM (Windows Dynamic Disks).
 284 leds/
 285         - directory with info about LED handling under Linux.
 286 local_ops.txt
 287         - semantics and behavior of local atomic operations.
 288 lockdep-design.txt
 289         - documentation on the runtime locking correctness validator.
 290 locking/
 291         - directory with info about kernel locking primitives
 292 lockstat.txt
 293         - info on collecting statistics on locks (and contention).
 294 lockup-watchdogs.txt
 295         - info on soft and hard lockup detectors (aka nmi_watchdog).
 296 logo.gif
 297         - full colour GIF image of Linux logo (penguin - Tux).
 298 logo.txt
 299         - info on creator of above logo & site to get additional images from.
 300 m68k/
 301         - directory with info about Linux on Motorola 68k architecture.
 302 magic-number.txt
 303         - list of magic numbers used to mark/protect kernel data structures.
 304 md.txt
 305         - info on boot arguments for the multiple devices driver.
 306 media-framework.txt
 307         - info on media framework, its data structures, functions and usage.
 308 memory-barriers.txt
 309         - info on Linux kernel memory barriers.
 310 memory-devices/
 311         - directory with info on parts like the Texas Instruments EMIF driver
 312 memory-hotplug.txt
 313         - Hotpluggable memory support, how to use and current status.
 314 metag/
 315         - directory with info about Linux on Meta architecture.
 316 mips/
 317         - directory with info about Linux on MIPS architecture.
 318 misc-devices/
 319         - directory with info about devices using the misc dev subsystem
 320 mmc/
 321         - directory with info about the MMC subsystem
 322 mn10300/
 323         - directory with info about the mn10300 architecture port
 324 module-signing.txt
 325         - Kernel module signing for increased security when loading modules.
 326 mtd/
 327         - directory with info about memory technology devices (flash)
 328 mono.txt
 329         - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
 330 mutex-design.txt
 331         - info on the generic mutex subsystem.
 332 namespaces/
 333         - directory with various information about namespaces
 334 netlabel/
 335         - directory with information on the NetLabel subsystem.
 336 networking/
 337         - directory with info on various aspects of networking with Linux.
 338 nfc/
 339         - directory relating info about Near Field Communications support.
 340 nommu-mmap.txt
 341         - documentation about no-mmu memory mapping support.
 342 numastat.txt
 343         - info on how to read Numa policy hit/miss statistics in sysfs.
 344 oops-tracing.txt
 345         - how to decode those nasty internal kernel error dump messages.
 346 padata.txt
 347         - An introduction to the "padata" parallel execution API
 348 parisc/
 349         - directory with info on using Linux on PA-RISC architecture.
 350 parport.txt
 351         - how to use the parallel-port driver.
 352 parport-lowlevel.txt
 353         - description and usage of the low level parallel port functions.
 354 pcmcia/
 355         - info on the Linux PCMCIA driver.
 356 percpu-rw-semaphore.txt
 357         - RCU based read-write semaphore optimized for locking for reading
 358 phy.txt
 359         - Description of the generic PHY framework.
 360 pi-futex.txt
 361         - documentation on lightweight priority inheritance futexes.
 362 pinctrl.txt
 363         - info on pinctrl subsystem and the PINMUX/PINCONF and drivers
 364 pnp.txt
 365         - Linux Plug and Play documentation.
 366 power/
 367         - directory with info on Linux PCI power management.
 368 powerpc/
 369         - directory with info on using Linux with the PowerPC.
 370 prctl/
 371         - directory with info on the priveledge control subsystem
 372 preempt-locking.txt
 373         - info on locking under a preemptive kernel.
 374 printk-formats.txt
 375         - how to get printk format specifiers right
 376 pps/
 377         - directory with information on the pulse-per-second support
 378 ptp/
 379         - directory with info on support for IEEE 1588 PTP clocks in Linux.
 380 pwm.txt
 381         - info on the pulse width modulation driver subsystem
 382 ramoops.txt
 383         - documentation of the ramoops oops/panic logging module.
 384 rapidio/
 385         - directory with info on RapidIO packet-based fabric interconnect
 386 rbtree.txt
 387         - info on what red-black trees are and what they are for.
 388 remoteproc.txt
 389         - info on how to handle remote processor (e.g. AMP) offloads/usage.
 390 rfkill.txt
 391         - info on the radio frequency kill switch subsystem/support.
 392 robust-futex-ABI.txt
 393         - documentation of the robust futex ABI.
 394 robust-futexes.txt
 395         - a description of what robust futexes are.
 396 rpmsg.txt
 397         - info on the Remote Processor Messaging (rpmsg) Framework
 398 rt-mutex-design.txt
 399         - description of the RealTime mutex implementation design.
 400 rt-mutex.txt
 401         - desc. of RT-mutex subsystem with PI (Priority Inheritance) support.
 402 rtc.txt
 403         - notes on how to use the Real Time Clock (aka CMOS clock) driver.
 404 s390/
 405         - directory with info on using Linux on the IBM S390.
 406 scheduler/
 407         - directory with info on the scheduler.
 408 scsi/
 409         - directory with info on Linux scsi support.
 410 security/
 411         - directory that contains security-related info
 412 serial/
 413         - directory with info on the low level serial API.
 414 serial-console.txt
 415         - how to set up Linux with a serial line console as the default.
 416 sgi-ioc4.txt
 417         - description of the SGI IOC4 PCI (multi function) device.
 418 sh/
 419         - directory with info on porting Linux to a new architecture.
 420 smsc_ece1099.txt
 421         -info on the smsc Keyboard Scan Expansion/GPIO Expansion device.
 422 sound/
 423         - directory with info on sound card support.
 424 sparse.txt
 425         - info on how to obtain and use the sparse tool for typechecking.
 426 spi/
 427         - overview of Linux kernel Serial Peripheral Interface (SPI) support.
 428 spinlocks.txt
 429         - info on using spinlocks to provide exclusive access in kernel.
 430 stable_api_nonsense.txt
 431         - info on why the kernel does not have a stable in-kernel api or abi.
 432 stable_kernel_rules.txt
 433         - rules and procedures for the -stable kernel releases.
 434 static-keys.txt
 435         - info on how static keys allow debug code in hotpaths via patching
 436 svga.txt
 437         - short guide on selecting video modes at boot via VGA BIOS.
 438 sysfs-rules.txt
 439         - How not to use sysfs.
 440 sysctl/
 441         - directory with info on the /proc/sys/* files.
 442 sysrq.txt
 443         - info on the magic SysRq key.
 444 target/
 445         - directory with info on generating TCM v4 fabric .ko modules
 446 this_cpu_ops.txt
 447         - List rationale behind and the way to use this_cpu operations.
 448 thermal/
 449         - directory with information on managing thermal issues (CPU/temp)
 450 trace/
 451         - directory with info on tracing technologies within linux
 452 unaligned-memory-access.txt
 453         - info on how to avoid arch breaking unaligned memory access in code.
 454 unicode.txt
 455         - info on the Unicode character/font mapping used in Linux.
 456 unshare.txt
 457         - description of the Linux unshare system call.
 458 usb/
 459         - directory with info regarding the Universal Serial Bus.
 460 vDSO/
 461         - directory with info regarding virtual dynamic shared objects
 462 vfio.txt
 463         - info on Virtual Function I/O used in guest/hypervisor instances.
 464 vgaarbiter.txt
 465         - info on enable/disable the legacy decoding on different VGA devices
 466 video-output.txt
 467         - sysfs class driver interface to enable/disable a video output device.
 468 video4linux/
 469         - directory with info regarding video/TV/radio cards and linux.
 470 virtual/
 471         - directory with information on the various linux virtualizations.
 472 vm/
 473         - directory with info on the Linux vm code.
 474 vme_api.txt
 475         - file relating info on the VME bus API in linux
 476 volatile-considered-harmful.txt
 477         - Why the "volatile" type class should not be used
 478 w1/
 479         - directory with documents regarding the 1-wire (w1) subsystem.
 480 watchdog/
 481         - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
 482 wimax/
 483         - directory with info about Intel Wireless Wimax Connections
 484 workqueue.txt
 485         - information on the Concurrency Managed Workqueue implementation
 486 ww-mutex-design.txt
 487         - Intro to Mutex wait/would deadlock handling.s
 488 x86/x86_64/
 489         - directory with info on Linux support for AMD x86-64 (Hammer) machines.
 490 xtensa/
 491         - directory with documents relating to arch/xtensa port/implementation
 492 xz.txt
 493         - how to make use of the XZ data compression within linux kernel
 494 zh_CN/
 495         - directory with Chinese translations of various documents
 496 zorro.txt
 497         - info on writing drivers for Zorro bus devices found on Amigas.