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