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