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