00-INDEX 14.7 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.
Linus Torvalds's avatar
Linus Torvalds committed
42 43 44 45
RCU/
	- directory with info on RCU (read-copy update).
SAK.txt
	- info on Secure Attention Keys.
46 47
SM501.txt
	- Silicon Motion SM501 multimedia companion chip
Linus Torvalds's avatar
Linus Torvalds committed
48 49
VGA-softcursor.txt
	- how to change your VGA cursor from a blinking underscore.
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
assoc_array.txt
	- generic associative array intro.
64 65 66 67
atomic_ops.txt
	- semantics and behavior of atomic and bitmask operations.
auxdisplay/
	- misc. LCD driver documentation (cfag12864b, ks0108).
68 69
backlight/
	- directory with info on controlling backlights in flat panel displays
Linus Torvalds's avatar
Linus Torvalds committed
70 71
basic_profiling.txt
	- basic instructions for those who wants to profile Linux kernel.
72 73
bcache.txt
	- Block-layer cache on fast SSDs to improve slow (raid) I/O performance.
Linus Torvalds's avatar
Linus Torvalds committed
74 75
binfmt_misc.txt
	- info on the kernel support for extra binary formats.
76 77
blackfin/
	- directory with documentation for the Blackfin arch.
Linus Torvalds's avatar
Linus Torvalds committed
78 79
block/
	- info on the Block I/O (BIO) layer.
80 81
blockdev/
	- info on block devices & drivers
82 83 84 85
braille-console.txt
	- info on how to use serial devices for Braille support.
bt8xxgpio.txt
	- info on how to modify a bt8xx video card for GPIO usage.
86 87
btmrvl.txt
	- info on Marvell Bluetooth driver usage.
88 89
bus-devices/
	- directory with info on TI GPMC (General Purpose Memory Controller)
90 91
bus-virt-phys-mapping.txt
	- how to access I/O mapped memory from within device drivers.
Linus Torvalds's avatar
Linus Torvalds committed
92 93 94 95
cachetlb.txt
	- describes the cache/TLB flushing interfaces Linux uses.
cdrom/
	- directory with information on the CD-ROM drivers that Linux has.
96 97
cgroups/
	- cgroups features, including cpusets and memory controller.
98 99 100 101 102 103
circular-buffers.txt
	- how to make use of the existing circular buffer infrastructure
clk.txt
	- info on the common clock framework
coccinelle.txt
	- info on how to get and use the Coccinelle code checking tool.
104 105 106 107
connector/
	- docs on the netlink based userspace<->kernel space communication mod.
console/
	- documentation on Linux console drivers.
108 109
core-api/
	- documentation on kernel core components.
Linus Torvalds's avatar
Linus Torvalds committed
110 111
cpu-freq/
	- info on CPU frequency and voltage scaling.
112 113 114 115
cpu-hotplug.txt
	- document describing CPU hotplug support in the Linux kernel.
cpu-load.txt
	- document describing how CPU load statistics are collected.
116 117
cpuidle/
	- info on CPU_IDLE, CPU idle state management subsystem.
118 119
cputopology.txt
	- documentation on how CPU topology info is exported via sysfs.
120 121
crc32.txt
	- brief tutorial on CRC computation
Linus Torvalds's avatar
Linus Torvalds committed
122 123 124 125
cris/
	- directory with info about Linux on CRIS architecture.
crypto/
	- directory with info on the Crypto API.
126 127
dcdbas.txt
	- information on the Dell Systems Management Base Driver.
Linus Torvalds's avatar
Linus Torvalds committed
128 129
debugging-modules.txt
	- some notes on debugging modules after Linux 2.6.3.
130 131
debugging-via-ohci1394.txt
	- how to use firewire like a hardware debugger memory reader.
132 133
dell_rbu.txt
	- document demonstrating the use of the Dell Remote BIOS Update driver.
Linus Torvalds's avatar
Linus Torvalds committed
134 135
device-mapper/
	- directory with info on Device Mapper.
136 137 138 139 140 141
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
142 143
dontdiff
	- file containing a list of files that should never be diff'ed.
Linus Torvalds's avatar
Linus Torvalds committed
144 145
driver-model/
	- directory with info about Linux driver model.
146 147
dynamic-debug-howto.txt
	- how to use the dynamic debug (dyndbg) feature.
Linus Torvalds's avatar
Linus Torvalds committed
148 149
early-userspace/
	- info about initramfs, klibc, and userspace early during boot.
Adrian Bunk's avatar
Adrian Bunk committed
150 151
edac.txt
	- information on EDAC - Error Detection And Correction
152 153
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
154 155
eisa.txt
	- info on EISA bus support.
156 157
extcon/
	- directory with porting guide for Android kernel switch driver.
158 159
fault-injection/
	- dir with docs about the fault injection capabilities infrastructure.
Linus Torvalds's avatar
Linus Torvalds committed
160 161 162
fb/
	- directory with info on the frame buffer graphics abstraction layer.
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
Adrian Bunk's avatar
Adrian Bunk committed
170
frv/
171
	- Fujitsu FR-V Linux documentation.
172 173 174 175
futex-requeue-pi.txt
	- info on requeueing of tasks from a non-PI futex to a PI futex
gcov.txt
	- use of GCC's coverage testing tool "gcov" with the Linux kernel
176 177
gpio/
	- gpio related documentation
178 179
hid/
	- directory with information on human interface devices
Linus Torvalds's avatar
Linus Torvalds committed
180 181
highuid.txt
	- notes on the change from 16 bit to 32 bit user/group IDs.
182 183
hsi.txt
	- HSI subsystem overview.
184 185
hwspinlock.txt
	- hardware spinlock provides hardware assistance for synchronization
186 187
timers/
	- info on the timer related topics
Linus Torvalds's avatar
Linus Torvalds committed
188 189
hw_random.txt
	- info on Linux support for random number generator in i8xx chipsets.
190 191
hwmon/
	- directory with docs on various hardware monitoring drivers.
Linus Torvalds's avatar
Linus Torvalds committed
192 193 194 195
i2c/
	- directory with info about the I2C bus/protocol (2 wire, kHz speed).
i2o/
	- directory with info about the Linux I2O subsystem.
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
infiniband/
	- directory with documents concerning Linux InfiniBand support.
Linus Torvalds's avatar
Linus Torvalds committed
202 203
input/
	- info on Linux input device support.
204 205
intel_txt.txt
	- info on intel Trusted Execution Technology (intel TXT).
206 207
io-mapping.txt
	- description of io_mapping functions in linux/io-mapping.h
Linus Torvalds's avatar
Linus Torvalds committed
208 209
io_ordering.txt
	- info on ordering I/O writes to memory-mapped addresses.
210 211
ioctl/
	- directory with documents describing various IOCTL calls.
Linus Torvalds's avatar
Linus Torvalds committed
212 213
iostats.txt
	- info on I/O statistics Linux kernel provides.
214 215
irqflags-tracing.txt
	- how to use the irq-flags tracing feature.
Linus Torvalds's avatar
Linus Torvalds committed
216 217 218 219
isapnp.txt
	- info on Linux ISA Plug & Play support.
isdn/
	- directory with info on the Linux ISDN support, and supported cards.
220 221
ja_JP/
	- directory with Japanese translations of various documents
Linus Torvalds's avatar
Linus Torvalds committed
222 223
kbuild/
	- directory with info about the kernel build process.
224 225
kdump/
	- directory with mini HowTo on getting the crash dump code to work.
226
doc-guide/
227
	- how to write and format reStructuredText kernel documentation
228 229
kernel-per-CPU-kthreads.txt
	- List of all per-CPU kthreads and how they introduce jitter.
230 231 232 233 234 235
kmemcheck.txt
	- info on dynamic checker that detects uses of uninitialized memory.
kmemleak.txt
	- info on how to make use of the kernel memory leak detection system
ko_KR/
	- directory with Korean translations of various documents
Linus Torvalds's avatar
Linus Torvalds committed
236 237
kobject.txt
	- info of the kobject infrastructure of the Linux kernel.
238 239 240 241
kprobes.txt
	- documents the kernel probes debugging feature.
kref.txt
	- docs on adding reference counters (krefs) to kernel objects.
242 243
kselftest.txt
	- small unittests for (some) individual codepaths in the kernel.
244 245
laptops/
	- directory with laptop related info and laptop driver documentation.
Linus Torvalds's avatar
Linus Torvalds committed
246 247
ldm.txt
	- a brief description of LDM (Windows Dynamic Disks).
248 249
leds/
	- directory with info about LED handling under Linux.
250 251
local_ops.txt
	- semantics and behavior of local atomic operations.
252 253
locking/
	- directory with info about kernel locking primitives
254 255
lockup-watchdogs.txt
	- info on soft and hard lockup detectors (aka nmi_watchdog).
Linus Torvalds's avatar
Linus Torvalds committed
256
logo.gif
257
	- full colour GIF image of Linux logo (penguin - Tux).
Linus Torvalds's avatar
Linus Torvalds committed
258
logo.txt
259
	- info on creator of above logo & site to get additional images from.
260 261
lzo.txt
	- kernel LZO decompressor input formats
Linus Torvalds's avatar
Linus Torvalds committed
262 263 264 265
m68k/
	- directory with info about Linux on Motorola 68k architecture.
magic-number.txt
	- list of magic numbers used to mark/protect kernel data structures.
266 267
mailbox.txt
	- How to write drivers for the common mailbox framework (IPC).
268 269
media-framework.txt
	- info on media framework, its data structures, functions and usage.
270 271
memory-barriers.txt
	- info on Linux kernel memory barriers.
272 273
memory-devices/
	- directory with info on parts like the Texas Instruments EMIF driver
274 275
memory-hotplug.txt
	- Hotpluggable memory support, how to use and current status.
James Hogan's avatar
James Hogan committed
276 277
metag/
	- directory with info about Linux on Meta architecture.
Linus Torvalds's avatar
Linus Torvalds committed
278 279
mips/
	- directory with info about Linux on MIPS architecture.
280 281
misc-devices/
	- directory with info about devices using the misc dev subsystem
282 283
mmc/
	- directory with info about the MMC subsystem
284 285
mn10300/
	- directory with info about the mn10300 architecture port
286 287
module-signing.txt
	- Kernel module signing for increased security when loading modules.
288 289
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
nommu-mmap.txt
	- documentation about no-mmu memory mapping support.
Linus Torvalds's avatar
Linus Torvalds committed
300 301
numastat.txt
	- info on how to read Numa policy hit/miss statistics in sysfs.
302 303
padata.txt
	- An introduction to the "padata" parallel execution API
Linus Torvalds's avatar
Linus Torvalds committed
304 305 306 307 308 309
parisc/
	- directory with info on using Linux on PA-RISC architecture.
parport.txt
	- how to use the parallel-port driver.
parport-lowlevel.txt
	- description and usage of the low level parallel port functions.
310 311
pcmcia/
	- info on the Linux PCMCIA driver.
312 313
percpu-rw-semaphore.txt
	- RCU based read-write semaphore optimized for locking for reading
314 315
phy.txt
	- Description of the generic PHY framework.
316
pi-futex.txt
317 318 319
	- documentation on lightweight priority inheritance futexes.
pinctrl.txt
	- info on pinctrl subsystem and the PINMUX/PINCONF and drivers
Linus Torvalds's avatar
Linus Torvalds committed
320 321 322 323 324 325
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.
326 327
prctl/
	- directory with info on the priveledge control subsystem
Linus Torvalds's avatar
Linus Torvalds committed
328 329
preempt-locking.txt
	- info on locking under a preemptive kernel.
Randy Dunlap's avatar
Randy Dunlap committed
330 331
printk-formats.txt
	- how to get printk format specifiers right
332 333
process/
	- how to work with the mainline kernel development process.
334 335 336 337 338 339 340 341
pps/
	- directory with information on the pulse-per-second support
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
342 343
rbtree.txt
	- info on what red-black trees are and what they are for.
344 345 346 347
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.
348 349 350 351
robust-futex-ABI.txt
	- documentation of the robust futex ABI.
robust-futexes.txt
	- a description of what robust futexes are.
352 353
rpmsg.txt
	- info on the Remote Processor Messaging (rpmsg) Framework
Linus Torvalds's avatar
Linus Torvalds committed
354 355 356 357
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.
358 359
scheduler/
	- directory with info on the scheduler.
Linus Torvalds's avatar
Linus Torvalds committed
360 361
scsi/
	- directory with info on Linux scsi support.
Randy Dunlap's avatar
Randy Dunlap committed
362 363
security/
	- directory that contains security-related info
Linus Torvalds's avatar
Linus Torvalds committed
364 365
serial/
	- directory with info on the low level serial API.
366 367
sgi-ioc4.txt
	- description of the SGI IOC4 PCI (multi function) device.
Linus Torvalds's avatar
Linus Torvalds committed
368 369
sh/
	- directory with info on porting Linux to a new architecture.
370 371
smsc_ece1099.txt
	-info on the smsc Keyboard Scan Expansion/GPIO Expansion device.
Linus Torvalds's avatar
Linus Torvalds committed
372 373
sound/
	- directory with info on sound card support.
374 375 376 377
sparse.txt
	- info on how to obtain and use the sparse tool for typechecking.
spi/
	- overview of Linux kernel Serial Peripheral Interface (SPI) support.
378 379
static-keys.txt
	- info on how static keys allow debug code in hotpaths via patching
Linus Torvalds's avatar
Linus Torvalds committed
380 381
svga.txt
	- short guide on selecting video modes at boot via VGA BIOS.
382 383
sysfs-rules.txt
	- How not to use sysfs.
Linus Torvalds's avatar
Linus Torvalds committed
384 385 386 387
sysctl/
	- directory with info on the /proc/sys/* files.
sysrq.txt
	- info on the magic SysRq key.
388 389
target/
	- directory with info on generating TCM v4 fabric .ko modules
390 391
this_cpu_ops.txt
	- List rationale behind and the way to use this_cpu operations.
392 393 394 395 396 397
thermal/
	- directory with information on managing thermal issues (CPU/temp)
trace/
	- directory with info on tracing technologies within linux
unaligned-memory-access.txt
	- info on how to avoid arch breaking unaligned memory access in code.
398 399
unshare.txt
	- description of the Linux unshare system call.
Linus Torvalds's avatar
Linus Torvalds committed
400 401
usb/
	- directory with info regarding the Universal Serial Bus.
402 403 404 405 406 407
vDSO/
	- directory with info regarding virtual dynamic shared objects
vfio.txt
	- info on Virtual Function I/O used in guest/hypervisor instances.
vgaarbiter.txt
	- info on enable/disable the legacy decoding on different VGA devices
408 409
video-output.txt
	- sysfs class driver interface to enable/disable a video output device.
410 411
virtual/
	- directory with information on the various linux virtualizations.
Linus Torvalds's avatar
Linus Torvalds committed
412 413
vm/
	- directory with info on the Linux vm code.
414 415
vme_api.txt
	- file relating info on the VME bus API in linux
416 417
w1/
	- directory with documents regarding the 1-wire (w1) subsystem.
Linus Torvalds's avatar
Linus Torvalds committed
418 419
watchdog/
	- how to auto-reboot Linux if it has "fallen and can't get up". ;-)
420 421
wimax/
	- directory with info about Intel Wireless Wimax Connections
422
core-api/workqueue.rst
423
	- information on the Concurrency Managed Workqueue implementation
Uwe Hermann's avatar
Uwe Hermann committed
424
x86/x86_64/
Linus Torvalds's avatar
Linus Torvalds committed
425
	- directory with info on Linux support for AMD x86-64 (Hammer) machines.
426 427
xillybus.txt
	- Overview and basic ui of xillybus driver
428 429 430 431 432 433
xtensa/
	- directory with documents relating to arch/xtensa port/implementation
xz.txt
	- how to make use of the XZ data compression within linux kernel
zh_CN/
	- directory with Chinese translations of various documents
Linus Torvalds's avatar
Linus Torvalds committed
434 435
zorro.txt
	- info on writing drivers for Zorro bus devices found on Amigas.