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 CodingStyle
  18         - nothing here, just a pointer to process/coding-style.rst.
  19 DMA-API.txt
  20         - DMA API, pci_ API & extensions for non-consistent memory machines.
  21 DMA-API-HOWTO.txt
  22         - Dynamic DMA mapping Guide
  23 DMA-ISA-LPC.txt
  24         - How to do DMA with ISA (and LPC) devices.
  25 DMA-attributes.txt
  26         - listing of the various possible attributes a DMA region can have
  27 DocBook/
  28         - directory with DocBook templates etc. for kernel documentation.
  29 EDID/
  30         - directory with info on customizing EDID for broken gfx/displays.
  31 IPMI.txt
  32         - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
  33 IRQ-affinity.txt
  34         - how to select which CPU(s) handle which interrupt events on SMP.
  35 IRQ-domain.txt
  36         - info on interrupt numbering and setting up IRQ domains.
  37 IRQ.txt
  38         - description of what an IRQ is.
  39 Intel-IOMMU.txt
  40         - basic info on the Intel IOMMU virtualization support.
  41 Makefile
  42         - This file does nothing. Removing it breaks make htmldocs and
  43           make distclean.
  44 Makefile.sphinx
  45         - This file does nothing. Removing it breaks make htmldocs and
  46           make distclean.
  47 PCI/
  48         - info related to PCI drivers.
  49 RCU/
  50         - directory with info on RCU (read-copy update).
  51 SAK.txt
  52         - info on Secure Attention Keys.
  53 SM501.txt
  54         - Silicon Motion SM501 multimedia companion chip
  55 SubmittingPatches
  56         - nothing here, just a pointer to process/coding-style.rst.
  57 accounting/
  58         - documentation on accounting and taskstats.
  59 acpi/
  60         - info on ACPI-specific hooks in the kernel.
  61 admin-guide/
  62         - info related to Linux users and system admins.
  63 aoe/
  64         - description of AoE (ATA over Ethernet) along with config examples.
  65 arm/
  66         - directory with info about Linux on the ARM architecture.
  67 arm64/
  68         - directory with info about Linux on the 64 bit ARM architecture.
  69 auxdisplay/
  70         - misc. LCD driver documentation (cfag12864b, ks0108).
  71 backlight/
  72         - directory with info on controlling backlights in flat panel displays
  73 bcache.txt
  74         - Block-layer cache on fast SSDs to improve slow (raid) I/O performance.
  75 blackfin/
  76         - directory with documentation for the Blackfin arch.
  77 block/
  78         - info on the Block I/O (BIO) layer.
  79 blockdev/
  80         - info on block devices & drivers
  81 bt8xxgpio.txt
  82         - info on how to modify a bt8xx video card for GPIO usage.
  83 btmrvl.txt
  84         - info on Marvell Bluetooth driver usage.
  85 bus-devices/
  86         - directory with info on TI GPMC (General Purpose Memory Controller)
  87 bus-virt-phys-mapping.txt
  88         - how to access I/O mapped memory from within device drivers.
  89 cachetlb.txt
  90         - describes the cache/TLB flushing interfaces Linux uses.
  91 cdrom/
  92         - directory with information on the CD-ROM drivers that Linux has.
  93 cgroup-v1/
  94         - cgroups v1 features, including cpusets and memory controller.
  95 cgroup-v2.txt
  96         - cgroups v2 features, including cpusets and memory controller.
  97 circular-buffers.txt
  98         - how to make use of the existing circular buffer infrastructure
  99 clk.txt
 100         - info on the common clock framework
 101 cma/
 102         - Continuous Memory Area (CMA) debugfs interface.
 103 conf.py
 104         - nothing here. Just a configuration file for Sphinx.
 105 connector/
 106         - docs on the netlink based userspace<->kernel space communication mod.
 107 console/
 108         - documentation on Linux console drivers.
 109 core-api/
 110         - documentation on kernel core components.
 111 cpu-freq/
 112         - info on CPU frequency and voltage scaling.
 113 cpu-hotplug.txt
 114         - document describing CPU hotplug support in the Linux kernel.
 115 cpu-load.txt
 116         - document describing how CPU load statistics are collected.
 117 cpuidle/
 118         - info on CPU_IDLE, CPU idle state management subsystem.
 119 cputopology.txt
 120         - documentation on how CPU topology info is exported via sysfs.
 121 crc32.txt
 122         - brief tutorial on CRC computation
 123 cris/
 124         - directory with info about Linux on CRIS architecture.
 125 crypto/
 126         - directory with info on the Crypto API.
 127 dcdbas.txt
 128         - information on the Dell Systems Management Base Driver.
 129 debugging-modules.txt
 130         - some notes on debugging modules after Linux 2.6.3.
 131 debugging-via-ohci1394.txt
 132         - how to use firewire like a hardware debugger memory reader.
 133 dell_rbu.txt
 134         - document demonstrating the use of the Dell Remote BIOS Update driver.
 135 dev-tools/
 136         - directory with info on development tools for the kernel.
 137 device-mapper/
 138         - directory with info on Device Mapper.
 139 dmaengine/
 140         - the DMA engine and controller API guides.
 141 devicetree/
 142         - directory with info on device tree files used by OF/PowerPC/ARM
 143 digsig.txt
 144         -info on the Digital Signature Verification API
 145 dma-buf-sharing.txt
 146         - the DMA Buffer Sharing API Guide
 147 docutils.conf
 148         - nothing here. Just a configuration file for docutils.
 149 dontdiff
 150         - file containing a list of files that should never be diff'ed.
 151 driver-api/
 152         - the Linux driver implementer's API guide.
 153 driver-model/
 154         - directory with info about Linux driver model.
 155 early-userspace/
 156         - info about initramfs, klibc, and userspace early during boot.
 157 edac.txt
 158         - information on EDAC - Error Detection And Correction
 159 efi-stub.txt
 160         - How to use the EFI boot stub to bypass GRUB or elilo on EFI systems.
 161 eisa.txt
 162         - info on EISA bus support.
 163 extcon/
 164         - directory with porting guide for Android kernel switch driver.
 165 isa.txt
 166         - info on EISA bus support.
 167 fault-injection/
 168         - dir with docs about the fault injection capabilities infrastructure.
 169 fb/
 170         - directory with info on the frame buffer graphics abstraction layer.
 171 features/
 172         - status of feature implementation on different architectures.
 173 filesystems/
 174         - info on the vfs and the various filesystems that Linux supports.
 175 firmware_class/
 176         - request_firmware() hotplug interface info.
 177 flexible-arrays.txt
 178         - how to make use of flexible sized arrays in linux
 179 fmc/
 180         - information about the FMC bus abstraction
 181 fpga/
 182         - FPGA Manager Core.
 183 frv/
 184         - Fujitsu FR-V Linux documentation.
 185 futex-requeue-pi.txt
 186         - info on requeueing of tasks from a non-PI futex to a PI futex
 187 gcc-plugins.txt
 188         - GCC plugin infrastructure.
 189 gpio/
 190         - gpio related documentation
 191 gpu/
 192         - directory with information on GPU driver developer's guide.
 193 hid/
 194         - directory with information on human interface devices
 195 highuid.txt
 196         - notes on the change from 16 bit to 32 bit user/group IDs.
 197 hwspinlock.txt
 198         - hardware spinlock provides hardware assistance for synchronization
 199 timers/
 200         - info on the timer related topics
 201 hw_random.txt
 202         - info on Linux support for random number generator in i8xx chipsets.
 203 hwmon/
 204         - directory with docs on various hardware monitoring drivers.
 205 i2c/
 206         - directory with info about the I2C bus/protocol (2 wire, kHz speed).
 207 x86/i386/
 208         - directory with info about Linux on Intel 32 bit architecture.
 209 ia64/
 210         - directory with info about Linux on Intel 64 bit architecture.
 211 ide/
 212         - Information regarding the Enhanced IDE drive.
 213 iio/
 214         - info on industrial IIO configfs support.
 215 index.rst
 216         - main index for the documentation at ReST format.
 217 infiniband/
 218         - directory with documents concerning Linux InfiniBand support.
 219 input/
 220         - info on Linux input device support.
 221 intel_txt.txt
 222         - info on intel Trusted Execution Technology (intel TXT).
 223 io-mapping.txt
 224         - description of io_mapping functions in linux/io-mapping.h
 225 io_ordering.txt
 226         - info on ordering I/O writes to memory-mapped addresses.
 227 ioctl/
 228         - directory with documents describing various IOCTL calls.
 229 iostats.txt
 230         - info on I/O statistics Linux kernel provides.
 231 irqflags-tracing.txt
 232         - how to use the irq-flags tracing feature.
 233 isapnp.txt
 234         - info on Linux ISA Plug & Play support.
 235 isdn/
 236         - directory with info on the Linux ISDN support, and supported cards.
 237 kbuild/
 238         - directory with info about the kernel build process.
 239 kernel-doc-nano-HOWTO.txt
 240         - outdated info about kernel-doc documentation.
 241 kdump/
 242         - directory with mini HowTo on getting the crash dump code to work.
 243 doc-guide/
 244         - how to write and format reStructuredText kernel documentation
 245 kernel-per-CPU-kthreads.txt
 246         - List of all per-CPU kthreads and how they introduce jitter.
 247 kobject.txt
 248         - info of the kobject infrastructure of the Linux kernel.
 249 kprobes.txt
 250         - documents the kernel probes debugging feature.
 251 kref.txt
 252         - docs on adding reference counters (krefs) to kernel objects.
 253 kselftest.txt
 254         - small unittests for (some) individual codepaths in the kernel.
 255 laptops/
 256         - directory with laptop related info and laptop driver documentation.
 257 ldm.txt
 258         - a brief description of LDM (Windows Dynamic Disks).
 259 leds/
 260         - directory with info about LED handling under Linux.
 261 livepatch/
 262         - info on kernel live patching.
 263 locking/
 264         - directory with info about kernel locking primitives
 265 lockup-watchdogs.txt
 266         - info on soft and hard lockup detectors (aka nmi_watchdog).
 267 logo.gif
 268         - full colour GIF image of Linux logo (penguin - Tux).
 269 logo.txt
 270         - info on creator of above logo & site to get additional images from.
 271 lzo.txt
 272         - kernel LZO decompressor input formats
 273 m68k/
 274         - directory with info about Linux on Motorola 68k architecture.
 275 mailbox.txt
 276         - How to write drivers for the common mailbox framework (IPC).
 277 md-cluster.txt
 278         - info on shared-device RAID MD cluster.
 279 media/
 280         - info on media drivers: uAPI, kAPI and driver documentation.
 281 memory-barriers.txt
 282         - info on Linux kernel memory barriers.
 283 memory-devices/
 284         - directory with info on parts like the Texas Instruments EMIF driver
 285 memory-hotplug.txt
 286         - Hotpluggable memory support, how to use and current status.
 287 men-chameleon-bus.txt
 288         - info on MEN chameleon bus.
 289 metag/
 290         - directory with info about Linux on Meta architecture.
 291 mic/
 292         - Intel Many Integrated Core (MIC) architecture device driver.
 293 mips/
 294         - directory with info about Linux on MIPS architecture.
 295 misc-devices/
 296         - directory with info about devices using the misc dev subsystem
 297 mmc/
 298         - directory with info about the MMC subsystem
 299 mn10300/
 300         - directory with info about the mn10300 architecture port
 301 mtd/
 302         - directory with info about memory technology devices (flash)
 303 namespaces/
 304         - directory with various information about namespaces
 305 netlabel/
 306         - directory with information on the NetLabel subsystem.
 307 networking/
 308         - directory with info on various aspects of networking with Linux.
 309 nfc/
 310         - directory relating info about Near Field Communications support.
 311 nios2/
 312         - Linux on the Nios II architecture.
 313 nommu-mmap.txt
 314         - documentation about no-mmu memory mapping support.
 315 numastat.txt
 316         - info on how to read Numa policy hit/miss statistics in sysfs.
 317 ntb.txt
 318         - info on Non-Transparent Bridge (NTB) drivers.
 319 nvdimm/
 320         - info on non-volatile devices.
 321 nvmem/
 322         - info on non volatile memory framework.
 323 output/
 324         - default directory where html/LaTeX/pdf files will be written.
 325 padata.txt
 326         - An introduction to the "padata" parallel execution API
 327 parisc/
 328         - directory with info on using Linux on PA-RISC architecture.
 329 parport-lowlevel.txt
 330         - description and usage of the low level parallel port functions.
 331 pcmcia/
 332         - info on the Linux PCMCIA driver.
 333 percpu-rw-semaphore.txt
 334         - RCU based read-write semaphore optimized for locking for reading
 335 perf/
 336         - info about the APM X-Gene SoC Performance Monitoring Unit (PMU).
 337 phy/
 338         - ino on Samsung USB 2.0 PHY adaptation layer.
 339 phy.txt
 340         - Description of the generic PHY framework.
 341 pi-futex.txt
 342         - documentation on lightweight priority inheritance futexes.
 343 pinctrl.txt
 344         - info on pinctrl subsystem and the PINMUX/PINCONF and drivers
 345 platform/
 346         - List of supported hardware by compal and Dell laptop.
 347 pnp.txt
 348         - Linux Plug and Play documentation.
 349 power/
 350         - directory with info on Linux PCI power management.
 351 powerpc/
 352         - directory with info on using Linux with the PowerPC.
 353 prctl/
 354         - directory with info on the priveledge control subsystem
 355 preempt-locking.txt
 356         - info on locking under a preemptive kernel.
 357 printk-formats.txt
 358         - how to get printk format specifiers right
 359 process/
 360         - how to work with the mainline kernel development process.
 361 pps/
 362         - directory with information on the pulse-per-second support
 363 pti/
 364         - directory with info on Intel MID PTI.
 365 ptp/
 366         - directory with info on support for IEEE 1588 PTP clocks in Linux.
 367 pwm.txt
 368         - info on the pulse width modulation driver subsystem
 369 rapidio/
 370         - directory with info on RapidIO packet-based fabric interconnect
 371 rbtree.txt
 372         - info on what red-black trees are and what they are for.
 373 remoteproc.txt
 374         - info on how to handle remote processor (e.g. AMP) offloads/usage.
 375 rfkill.txt
 376         - info on the radio frequency kill switch subsystem/support.
 377 robust-futex-ABI.txt
 378         - documentation of the robust futex ABI.
 379 robust-futexes.txt
 380         - a description of what robust futexes are.
 381 rpmsg.txt
 382         - info on the Remote Processor Messaging (rpmsg) Framework
 383 rtc.txt
 384         - notes on how to use the Real Time Clock (aka CMOS clock) driver.
 385 s390/
 386         - directory with info on using Linux on the IBM S390.
 387 scheduler/
 388         - directory with info on the scheduler.
 389 scsi/
 390         - directory with info on Linux scsi support.
 391 security/
 392         - directory that contains security-related info
 393 serial/
 394         - directory with info on the low level serial API.
 395 sgi-ioc4.txt
 396         - description of the SGI IOC4 PCI (multi function) device.
 397 sh/
 398         - directory with info on porting Linux to a new architecture.
 399 smsc_ece1099.txt
 400         -info on the smsc Keyboard Scan Expansion/GPIO Expansion device.
 401 sound/
 402         - directory with info on sound card support.
 403 spi/
 404         - overview of Linux kernel Serial Peripheral Interface (SPI) support.
 405 sphinx/
 406         - no doumentation here, just files required by Sphinx toolchain.
 407 sphinx-static/
 408         - no doumentation here, just files required by Sphinx toolchain.
 409 static-keys.txt
 410         - info on how static keys allow debug code in hotpaths via patching
 411 svga.txt
 412         - short guide on selecting video modes at boot via VGA BIOS.
 413 sync_file.txt
 414         - Sync file API guide.
 415 sysctl/
 416         - directory with info on the /proc/sys/* files.
 417 target/
 418         - directory with info on generating TCM v4 fabric .ko modules
 419 this_cpu_ops.txt
 420         - List rationale behind and the way to use this_cpu operations.
 421 thermal/
 422         - directory with information on managing thermal issues (CPU/temp)
 423 trace/
 424         - directory with info on tracing technologies within linux
 425 translations/
 426         - translations of this document from English to another language
 427 unaligned-memory-access.txt
 428         - info on how to avoid arch breaking unaligned memory access in code.
 429 unshare.txt
 430         - description of the Linux unshare system call.
 431 usb/
 432         - directory with info regarding the Universal Serial Bus.
 433 vfio.txt
 434         - info on Virtual Function I/O used in guest/hypervisor instances.
 435 video-output.txt
 436         - sysfs class driver interface to enable/disable a video output device.
 437 virtual/
 438         - directory with information on the various linux virtualizations.
 439 vm/
 440         - directory with info on the Linux vm code.
 441 w1/
 442         - directory with documents regarding the 1-wire (w1) subsystem.
 443 watchdog/
 444         - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
 445 wimax/
 446         - directory with info about Intel Wireless Wimax Connections
 447 core-api/workqueue.rst
 448         - information on the Concurrency Managed Workqueue implementation
 449 x86/x86_64/
 450         - directory with info on Linux support for AMD x86-64 (Hammer) machines.
 451 xillybus.txt
 452         - Overview and basic ui of xillybus driver
 453 xtensa/
 454         - directory with documents relating to arch/xtensa port/implementation
 455 xz.txt
 456         - how to make use of the XZ data compression within linux kernel
 457 zorro.txt
 458         - info on writing drivers for Zorro bus devices found on Amigas.