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