Back to home page

LXR

 
 

    


0001 
0002 This is a brief list of all the files in ./linux/Documentation and what
0003 they contain. If you add a documentation file, please list it here in
0004 alphabetical order as well, or risk being hunted down like a rabid dog.
0005 Please keep the descriptions small enough to fit on one line.
0006                                                          Thanks -- Paul G.
0007 
0008 Following translations are available on the WWW:
0009 
0010    - Japanese, maintained by the JF Project (jf@listserv.linux.or.jp), at
0011      http://linuxjf.sourceforge.jp/
0012 
0013 00-INDEX
0014         - this file.
0015 ABI/
0016         - info on kernel <-> userspace ABI and relative interface stability.
0017 CodingStyle
0018         - nothing here, just a pointer to process/coding-style.rst.
0019 DMA-API.txt
0020         - DMA API, pci_ API & extensions for non-consistent memory machines.
0021 DMA-API-HOWTO.txt
0022         - Dynamic DMA mapping Guide
0023 DMA-ISA-LPC.txt
0024         - How to do DMA with ISA (and LPC) devices.
0025 DMA-attributes.txt
0026         - listing of the various possible attributes a DMA region can have
0027 DocBook/
0028         - directory with DocBook templates etc. for kernel documentation.
0029 EDID/
0030         - directory with info on customizing EDID for broken gfx/displays.
0031 IPMI.txt
0032         - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
0033 IRQ-affinity.txt
0034         - how to select which CPU(s) handle which interrupt events on SMP.
0035 IRQ-domain.txt
0036         - info on interrupt numbering and setting up IRQ domains.
0037 IRQ.txt
0038         - description of what an IRQ is.
0039 Intel-IOMMU.txt
0040         - basic info on the Intel IOMMU virtualization support.
0041 Makefile
0042         - It's not of interest for those who aren't touching the build system.
0043 Makefile.sphinx
0044         - It's not of interest for those who aren't touching the build system.
0045 PCI/
0046         - info related to PCI drivers.
0047 RCU/
0048         - directory with info on RCU (read-copy update).
0049 SAK.txt
0050         - info on Secure Attention Keys.
0051 SM501.txt
0052         - Silicon Motion SM501 multimedia companion chip
0053 SubmittingPatches
0054         - nothing here, just a pointer to process/coding-style.rst.
0055 accounting/
0056         - documentation on accounting and taskstats.
0057 acpi/
0058         - info on ACPI-specific hooks in the kernel.
0059 admin-guide/
0060         - info related to Linux users and system admins.
0061 aoe/
0062         - description of AoE (ATA over Ethernet) along with config examples.
0063 arm/
0064         - directory with info about Linux on the ARM architecture.
0065 arm64/
0066         - directory with info about Linux on the 64 bit ARM architecture.
0067 auxdisplay/
0068         - misc. LCD driver documentation (cfag12864b, ks0108).
0069 backlight/
0070         - directory with info on controlling backlights in flat panel displays
0071 bcache.txt
0072         - Block-layer cache on fast SSDs to improve slow (raid) I/O performance.
0073 blackfin/
0074         - directory with documentation for the Blackfin arch.
0075 block/
0076         - info on the Block I/O (BIO) layer.
0077 blockdev/
0078         - info on block devices & drivers
0079 bt8xxgpio.txt
0080         - info on how to modify a bt8xx video card for GPIO usage.
0081 btmrvl.txt
0082         - info on Marvell Bluetooth driver usage.
0083 bus-devices/
0084         - directory with info on TI GPMC (General Purpose Memory Controller)
0085 bus-virt-phys-mapping.txt
0086         - how to access I/O mapped memory from within device drivers.
0087 cachetlb.txt
0088         - describes the cache/TLB flushing interfaces Linux uses.
0089 cdrom/
0090         - directory with information on the CD-ROM drivers that Linux has.
0091 cgroup-v1/
0092         - cgroups v1 features, including cpusets and memory controller.
0093 cgroup-v2.txt
0094         - cgroups v2 features, including cpusets and memory controller.
0095 circular-buffers.txt
0096         - how to make use of the existing circular buffer infrastructure
0097 clk.txt
0098         - info on the common clock framework
0099 cma/
0100         - Continuous Memory Area (CMA) debugfs interface.
0101 conf.py
0102         - It's not of interest for those who aren't touching the build system.
0103 connector/
0104         - docs on the netlink based userspace<->kernel space communication mod.
0105 console/
0106         - documentation on Linux console drivers.
0107 core-api/
0108         - documentation on kernel core components.
0109 cpu-freq/
0110         - info on CPU frequency and voltage scaling.
0111 cpu-hotplug.txt
0112         - document describing CPU hotplug support in the Linux kernel.
0113 cpu-load.txt
0114         - document describing how CPU load statistics are collected.
0115 cpuidle/
0116         - info on CPU_IDLE, CPU idle state management subsystem.
0117 cputopology.txt
0118         - documentation on how CPU topology info is exported via sysfs.
0119 crc32.txt
0120         - brief tutorial on CRC computation
0121 cris/
0122         - directory with info about Linux on CRIS architecture.
0123 crypto/
0124         - directory with info on the Crypto API.
0125 dcdbas.txt
0126         - information on the Dell Systems Management Base Driver.
0127 debugging-modules.txt
0128         - some notes on debugging modules after Linux 2.6.3.
0129 debugging-via-ohci1394.txt
0130         - how to use firewire like a hardware debugger memory reader.
0131 dell_rbu.txt
0132         - document demonstrating the use of the Dell Remote BIOS Update driver.
0133 dev-tools/
0134         - directory with info on development tools for the kernel.
0135 device-mapper/
0136         - directory with info on Device Mapper.
0137 dmaengine/
0138         - the DMA engine and controller API guides.
0139 devicetree/
0140         - directory with info on device tree files used by OF/PowerPC/ARM
0141 digsig.txt
0142         -info on the Digital Signature Verification API
0143 dma-buf-sharing.txt
0144         - the DMA Buffer Sharing API Guide
0145 docutils.conf
0146         - nothing here. Just a configuration file for docutils.
0147 dontdiff
0148         - file containing a list of files that should never be diff'ed.
0149 driver-api/
0150         - the Linux driver implementer's API guide.
0151 driver-model/
0152         - directory with info about Linux driver model.
0153 early-userspace/
0154         - info about initramfs, klibc, and userspace early during boot.
0155 efi-stub.txt
0156         - How to use the EFI boot stub to bypass GRUB or elilo on EFI systems.
0157 eisa.txt
0158         - info on EISA bus support.
0159 extcon/
0160         - directory with porting guide for Android kernel switch driver.
0161 isa.txt
0162         - info on EISA bus support.
0163 fault-injection/
0164         - dir with docs about the fault injection capabilities infrastructure.
0165 fb/
0166         - directory with info on the frame buffer graphics abstraction layer.
0167 features/
0168         - status of feature implementation on different architectures.
0169 filesystems/
0170         - info on the vfs and the various filesystems that Linux supports.
0171 firmware_class/
0172         - request_firmware() hotplug interface info.
0173 flexible-arrays.txt
0174         - how to make use of flexible sized arrays in linux
0175 fmc/
0176         - information about the FMC bus abstraction
0177 fpga/
0178         - FPGA Manager Core.
0179 frv/
0180         - Fujitsu FR-V Linux documentation.
0181 futex-requeue-pi.txt
0182         - info on requeueing of tasks from a non-PI futex to a PI futex
0183 gcc-plugins.txt
0184         - GCC plugin infrastructure.
0185 gpio/
0186         - gpio related documentation
0187 gpu/
0188         - directory with information on GPU driver developer's guide.
0189 hid/
0190         - directory with information on human interface devices
0191 highuid.txt
0192         - notes on the change from 16 bit to 32 bit user/group IDs.
0193 hwspinlock.txt
0194         - hardware spinlock provides hardware assistance for synchronization
0195 timers/
0196         - info on the timer related topics
0197 hw_random.txt
0198         - info on Linux support for random number generator in i8xx chipsets.
0199 hwmon/
0200         - directory with docs on various hardware monitoring drivers.
0201 i2c/
0202         - directory with info about the I2C bus/protocol (2 wire, kHz speed).
0203 x86/i386/
0204         - directory with info about Linux on Intel 32 bit architecture.
0205 ia64/
0206         - directory with info about Linux on Intel 64 bit architecture.
0207 ide/
0208         - Information regarding the Enhanced IDE drive.
0209 iio/
0210         - info on industrial IIO configfs support.
0211 index.rst
0212         - main index for the documentation at ReST format.
0213 infiniband/
0214         - directory with documents concerning Linux InfiniBand support.
0215 input/
0216         - info on Linux input device support.
0217 intel_txt.txt
0218         - info on intel Trusted Execution Technology (intel TXT).
0219 io-mapping.txt
0220         - description of io_mapping functions in linux/io-mapping.h
0221 io_ordering.txt
0222         - info on ordering I/O writes to memory-mapped addresses.
0223 ioctl/
0224         - directory with documents describing various IOCTL calls.
0225 iostats.txt
0226         - info on I/O statistics Linux kernel provides.
0227 irqflags-tracing.txt
0228         - how to use the irq-flags tracing feature.
0229 isapnp.txt
0230         - info on Linux ISA Plug & Play support.
0231 isdn/
0232         - directory with info on the Linux ISDN support, and supported cards.
0233 kbuild/
0234         - directory with info about the kernel build process.
0235 kernel-doc-nano-HOWTO.txt
0236         - outdated info about kernel-doc documentation.
0237 kdump/
0238         - directory with mini HowTo on getting the crash dump code to work.
0239 doc-guide/
0240         - how to write and format reStructuredText kernel documentation
0241 kernel-per-CPU-kthreads.txt
0242         - List of all per-CPU kthreads and how they introduce jitter.
0243 kobject.txt
0244         - info of the kobject infrastructure of the Linux kernel.
0245 kprobes.txt
0246         - documents the kernel probes debugging feature.
0247 kref.txt
0248         - docs on adding reference counters (krefs) to kernel objects.
0249 kselftest.txt
0250         - small unittests for (some) individual codepaths in the kernel.
0251 laptops/
0252         - directory with laptop related info and laptop driver documentation.
0253 ldm.txt
0254         - a brief description of LDM (Windows Dynamic Disks).
0255 leds/
0256         - directory with info about LED handling under Linux.
0257 livepatch/
0258         - info on kernel live patching.
0259 locking/
0260         - directory with info about kernel locking primitives
0261 lockup-watchdogs.txt
0262         - info on soft and hard lockup detectors (aka nmi_watchdog).
0263 logo.gif
0264         - full colour GIF image of Linux logo (penguin - Tux).
0265 logo.txt
0266         - info on creator of above logo & site to get additional images from.
0267 lzo.txt
0268         - kernel LZO decompressor input formats
0269 m68k/
0270         - directory with info about Linux on Motorola 68k architecture.
0271 mailbox.txt
0272         - How to write drivers for the common mailbox framework (IPC).
0273 md-cluster.txt
0274         - info on shared-device RAID MD cluster.
0275 media/
0276         - info on media drivers: uAPI, kAPI and driver documentation.
0277 memory-barriers.txt
0278         - info on Linux kernel memory barriers.
0279 memory-devices/
0280         - directory with info on parts like the Texas Instruments EMIF driver
0281 memory-hotplug.txt
0282         - Hotpluggable memory support, how to use and current status.
0283 men-chameleon-bus.txt
0284         - info on MEN chameleon bus.
0285 metag/
0286         - directory with info about Linux on Meta architecture.
0287 mic/
0288         - Intel Many Integrated Core (MIC) architecture device driver.
0289 mips/
0290         - directory with info about Linux on MIPS architecture.
0291 misc-devices/
0292         - directory with info about devices using the misc dev subsystem
0293 mmc/
0294         - directory with info about the MMC subsystem
0295 mn10300/
0296         - directory with info about the mn10300 architecture port
0297 mtd/
0298         - directory with info about memory technology devices (flash)
0299 namespaces/
0300         - directory with various information about namespaces
0301 netlabel/
0302         - directory with information on the NetLabel subsystem.
0303 networking/
0304         - directory with info on various aspects of networking with Linux.
0305 nfc/
0306         - directory relating info about Near Field Communications support.
0307 nios2/
0308         - Linux on the Nios II architecture.
0309 nommu-mmap.txt
0310         - documentation about no-mmu memory mapping support.
0311 numastat.txt
0312         - info on how to read Numa policy hit/miss statistics in sysfs.
0313 ntb.txt
0314         - info on Non-Transparent Bridge (NTB) drivers.
0315 nvdimm/
0316         - info on non-volatile devices.
0317 nvmem/
0318         - info on non volatile memory framework.
0319 output/
0320         - default directory where html/LaTeX/pdf files will be written.
0321 padata.txt
0322         - An introduction to the "padata" parallel execution API
0323 parisc/
0324         - directory with info on using Linux on PA-RISC architecture.
0325 parport-lowlevel.txt
0326         - description and usage of the low level parallel port functions.
0327 pcmcia/
0328         - info on the Linux PCMCIA driver.
0329 percpu-rw-semaphore.txt
0330         - RCU based read-write semaphore optimized for locking for reading
0331 perf/
0332         - info about the APM X-Gene SoC Performance Monitoring Unit (PMU).
0333 phy/
0334         - ino on Samsung USB 2.0 PHY adaptation layer.
0335 phy.txt
0336         - Description of the generic PHY framework.
0337 pi-futex.txt
0338         - documentation on lightweight priority inheritance futexes.
0339 pinctrl.txt
0340         - info on pinctrl subsystem and the PINMUX/PINCONF and drivers
0341 platform/
0342         - List of supported hardware by compal and Dell laptop.
0343 pnp.txt
0344         - Linux Plug and Play documentation.
0345 power/
0346         - directory with info on Linux PCI power management.
0347 powerpc/
0348         - directory with info on using Linux with the PowerPC.
0349 prctl/
0350         - directory with info on the priveledge control subsystem
0351 preempt-locking.txt
0352         - info on locking under a preemptive kernel.
0353 printk-formats.txt
0354         - how to get printk format specifiers right
0355 process/
0356         - how to work with the mainline kernel development process.
0357 pps/
0358         - directory with information on the pulse-per-second support
0359 pti/
0360         - directory with info on Intel MID PTI.
0361 ptp/
0362         - directory with info on support for IEEE 1588 PTP clocks in Linux.
0363 pwm.txt
0364         - info on the pulse width modulation driver subsystem
0365 rapidio/
0366         - directory with info on RapidIO packet-based fabric interconnect
0367 rbtree.txt
0368         - info on what red-black trees are and what they are for.
0369 remoteproc.txt
0370         - info on how to handle remote processor (e.g. AMP) offloads/usage.
0371 rfkill.txt
0372         - info on the radio frequency kill switch subsystem/support.
0373 robust-futex-ABI.txt
0374         - documentation of the robust futex ABI.
0375 robust-futexes.txt
0376         - a description of what robust futexes are.
0377 rpmsg.txt
0378         - info on the Remote Processor Messaging (rpmsg) Framework
0379 rtc.txt
0380         - notes on how to use the Real Time Clock (aka CMOS clock) driver.
0381 s390/
0382         - directory with info on using Linux on the IBM S390.
0383 scheduler/
0384         - directory with info on the scheduler.
0385 scsi/
0386         - directory with info on Linux scsi support.
0387 security/
0388         - directory that contains security-related info
0389 serial/
0390         - directory with info on the low level serial API.
0391 sgi-ioc4.txt
0392         - description of the SGI IOC4 PCI (multi function) device.
0393 sh/
0394         - directory with info on porting Linux to a new architecture.
0395 smsc_ece1099.txt
0396         -info on the smsc Keyboard Scan Expansion/GPIO Expansion device.
0397 sound/
0398         - directory with info on sound card support.
0399 spi/
0400         - overview of Linux kernel Serial Peripheral Interface (SPI) support.
0401 sphinx/
0402         - no documentation here, just files required by Sphinx toolchain.
0403 sphinx-static/
0404         - no documentation here, just files required by Sphinx toolchain.
0405 static-keys.txt
0406         - info on how static keys allow debug code in hotpaths via patching
0407 svga.txt
0408         - short guide on selecting video modes at boot via VGA BIOS.
0409 sync_file.txt
0410         - Sync file API guide.
0411 sysctl/
0412         - directory with info on the /proc/sys/* files.
0413 target/
0414         - directory with info on generating TCM v4 fabric .ko modules
0415 this_cpu_ops.txt
0416         - List rationale behind and the way to use this_cpu operations.
0417 thermal/
0418         - directory with information on managing thermal issues (CPU/temp)
0419 trace/
0420         - directory with info on tracing technologies within linux
0421 translations/
0422         - translations of this document from English to another language
0423 unaligned-memory-access.txt
0424         - info on how to avoid arch breaking unaligned memory access in code.
0425 unshare.txt
0426         - description of the Linux unshare system call.
0427 usb/
0428         - directory with info regarding the Universal Serial Bus.
0429 vfio.txt
0430         - info on Virtual Function I/O used in guest/hypervisor instances.
0431 video-output.txt
0432         - sysfs class driver interface to enable/disable a video output device.
0433 virtual/
0434         - directory with information on the various linux virtualizations.
0435 vm/
0436         - directory with info on the Linux vm code.
0437 w1/
0438         - directory with documents regarding the 1-wire (w1) subsystem.
0439 watchdog/
0440         - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
0441 wimax/
0442         - directory with info about Intel Wireless Wimax Connections
0443 core-api/workqueue.rst
0444         - information on the Concurrency Managed Workqueue implementation
0445 x86/x86_64/
0446         - directory with info on Linux support for AMD x86-64 (Hammer) machines.
0447 xillybus.txt
0448         - Overview and basic ui of xillybus driver
0449 xtensa/
0450         - directory with documents relating to arch/xtensa port/implementation
0451 xz.txt
0452         - how to make use of the XZ data compression within linux kernel
0453 zorro.txt
0454         - info on writing drivers for Zorro bus devices found on Amigas.