00-INDEX 16.6 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

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