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