00-INDEX 15.1 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4

This is a brief list of all the files in ./linux/Documentation and what
they contain. If you add a documentation file, please list it here in
alphabetical order as well, or risk being hunted down like a rabid dog.
5
Please keep the descriptions small enough to fit on one line.
Linus Torvalds's avatar
Linus Torvalds committed
6 7 8 9
							 Thanks -- Paul G.

Following translations are available on the WWW:

10 11
   - Japanese, maintained by the JF Project (jf@listserv.linux.or.jp), at
     http://linuxjf.sourceforge.jp/
Linus Torvalds's avatar
Linus Torvalds committed
12 13 14

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