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