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