00-INDEX 14.3 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14

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.
Please try and keep the descriptions small enough to fit on one line.
							 Thanks -- Paul G.

Following translations are available on the WWW:

   - Japanese, maintained by the JF Project (JF@linux.or.jp), at
     http://www.linux.or.jp/JF/

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 23 24 25
BUG-HUNTING
	- brute force method of doing binary search of patches to find bug.
Changes
	- list of changes that break older software packages.
CodingStyle
	- how the boss likes the C code in the kernel to look.
DMA-API.txt
	- DMA API, pci_ API & extensions for non-consistent memory machines.
26 27
DMA-ISA-LPC.txt
	- How to do DMA with ISA (and LPC) devices.
Linus Torvalds's avatar
Linus Torvalds committed
28 29 30 31
DMA-mapping.txt
	- info for PCI drivers using DMA portably across all platforms.
DocBook/
	- directory with DocBook templates etc. for kernel documentation.
32
HOWTO
33
	- the process and procedures of how to do Linux kernel development.
Linus Torvalds's avatar
Linus Torvalds committed
34 35 36 37 38 39
IO-mapping.txt
	- how to access I/O mapped memory from within device drivers.
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.
40 41
IRQ.txt
	- description of what an IRQ is.
Linus Torvalds's avatar
Linus Torvalds committed
42 43 44 45
ManagementStyle
	- how to (attempt to) manage kernel hackers.
MSI-HOWTO.txt
	- the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ.
46 47
PCIEBUS-HOWTO.txt
	- a guide describing the PCI Express Port Bus driver.
Linus Torvalds's avatar
Linus Torvalds committed
48 49 50 51
RCU/
	- directory with info on RCU (read-copy update).
README.DAC960
	- info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux.
52 53
README.cycladesZ
	- info on Cyclades-Z firmware loading.
Linus Torvalds's avatar
Linus Torvalds committed
54 55
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 80 81
atomic_ops.txt
	- semantics and behavior of atomic and bitmask operations.
auxdisplay/
	- misc. LCD driver documentation (cfag12864b, ks0108).
Linus Torvalds's avatar
Linus Torvalds committed
82 83 84 85
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.
86 87
blackfin/
	- directory with documentation for the Blackfin arch.
Linus Torvalds's avatar
Linus Torvalds committed
88 89 90 91 92 93 94 95 96 97 98 99
block/
	- info on the Block I/O (BIO) layer.
cachetlb.txt
	- describes the cache/TLB flushing interfaces Linux uses.
cciss.txt
	- info, major/minor #'s for Compaq's SMART Array Controllers.
cdrom/
	- directory with information on the CD-ROM drivers that Linux has.
cli-sti-removal.txt
	- cli()/sti() removal guide.
computone.txt
	- info on Computone Intelliport II/Plus Multiport Serial Driver.
100 101 102 103
connector/
	- docs on the netlink based userspace<->kernel space communication mod.
console/
	- documentation on Linux console drivers.
Linus Torvalds's avatar
Linus Torvalds committed
104 105 106 107
cpqarray.txt
	- info on using Compaq's SMART2 Intelligent Disk Array Controllers.
cpu-freq/
	- info on CPU frequency and voltage scaling.
108 109 110 111 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.
cpusets.txt
	- documents the cpusets feature; assign CPUs and Mem to a set of tasks.
cputopology.txt
	- documentation on how CPU topology info is exported via sysfs.
Linus Torvalds's avatar
Linus Torvalds committed
116 117 118 119
cris/
	- directory with info about Linux on CRIS architecture.
crypto/
	- directory with info on the Crypto API.
120 121
dcdbas.txt
	- information on the Dell Systems Management Base Driver.
Linus Torvalds's avatar
Linus Torvalds committed
122 123
debugging-modules.txt
	- some notes on debugging modules after Linux 2.6.3.
124 125
dell_rbu.txt
	- document demonstrating the use of the Dell Remote BIOS Update driver.
Linus Torvalds's avatar
Linus Torvalds committed
126 127 128 129 130 131
device-mapper/
	- directory with info on Device Mapper.
devices.txt
	- plain ASCII listing of all the nodes in /dev/ with major minor #'s.
digiepca.txt
	- info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
132 133
dontdiff
	- file containing a list of files that should never be diff'ed.
Linus Torvalds's avatar
Linus Torvalds committed
134 135 136 137 138 139
driver-model/
	- directory with info about Linux driver model.
dvb/
	- info on Linux Digital Video Broadcast (DVB) subsystem.
early-userspace/
	- info about initramfs, klibc, and userspace early during boot.
Adrian Bunk's avatar
Adrian Bunk committed
140 141
edac.txt
	- information on EDAC - Error Detection And Correction
Linus Torvalds's avatar
Linus Torvalds committed
142 143 144 145
eisa.txt
	- info on EISA bus support.
exception.txt
	- how Linux v2.2 handles exceptions without verify_area etc.
146 147
fault-injection/
	- dir with docs about the fault injection capabilities infrastructure.
Linus Torvalds's avatar
Linus Torvalds committed
148 149
fb/
	- directory with info on the frame buffer graphics abstraction layer.
150 151
feature-removal-schedule.txt
	- list of files and features that are going to be removed.
Linus Torvalds's avatar
Linus Torvalds committed
152
filesystems/
153
	- info on the vfs and the various filesystems that Linux supports.
Linus Torvalds's avatar
Linus Torvalds committed
154 155 156 157
firmware_class/
	- request_firmware() hotplug interface info.
floppy.txt
	- notes and driver options for the floppy disk driver.
Adrian Bunk's avatar
Adrian Bunk committed
158
frv/
159 160 161
	- Fujitsu FR-V Linux documentation.
gpio.txt
	- overview of GPIO (General Purpose Input/Output) access conventions.
Linus Torvalds's avatar
Linus Torvalds committed
162 163 164 165 166 167
hayes-esp.txt
	- info on using the Hayes ESP serial driver.
highuid.txt
	- notes on the change from 16 bit to 32 bit user/group IDs.
hpet.txt
	- High Precision Event Timer Driver for Linux.
168 169 170 171
hrtimer/
	- info on the timer_stats debugging facility for timer (ab)use.
hrtimers/
	- info on the hrtimers subsystem for high-resolution kernel timers.
Linus Torvalds's avatar
Linus Torvalds committed
172 173
hw_random.txt
	- info on Linux support for random number generator in i8xx chipsets.
174 175
hwmon/
	- directory with docs on various hardware monitoring drivers.
Linus Torvalds's avatar
Linus Torvalds committed
176 177 178 179 180 181 182 183 184 185
i2c/
	- directory with info about the I2C bus/protocol (2 wire, kHz speed).
i2o/
	- directory with info about the Linux I2O subsystem.
i386/
	- directory with info about Linux on Intel 32 bit architecture.
ia64/
	- directory with info about Linux on Intel 64 bit architecture.
ide.txt
	- important info for users of ATA devices (IDE/EIDE disks and CD-ROMS).
186 187
infiniband/
	- directory with documents concerning Linux InfiniBand support.
Linus Torvalds's avatar
Linus Torvalds committed
188 189 190 191 192 193
initrd.txt
	- how to use the RAM disk as an initial/temporary root filesystem.
input/
	- info on Linux input device support.
io_ordering.txt
	- info on ordering I/O writes to memory-mapped addresses.
194 195
ioctl/
	- directory with documents describing various IOCTL calls.
Linus Torvalds's avatar
Linus Torvalds committed
196 197 198 199
ioctl-number.txt
	- how to implement and register device/driver ioctl calls.
iostats.txt
	- info on I/O statistics Linux kernel provides.
200 201
irqflags-tracing.txt
	- how to use the irq-flags tracing feature.
Linus Torvalds's avatar
Linus Torvalds committed
202 203 204 205 206 207 208 209
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).
kbuild/
	- directory with info about the kernel build process.
210 211
kdump/
	- directory with mini HowTo on getting the crash dump code to work.
Linus Torvalds's avatar
Linus Torvalds committed
212 213 214 215 216 217
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.
218 219 220 221
keys-request-key.txt
	- description of the kernel key request service.
keys.txt
	- description of the kernel key retention service.
Linus Torvalds's avatar
Linus Torvalds committed
222 223
kobject.txt
	- info of the kobject infrastructure of the Linux kernel.
224 225 226 227
kprobes.txt
	- documents the kernel probes debugging feature.
kref.txt
	- docs on adding reference counters (krefs) to kernel objects.
Linus Torvalds's avatar
Linus Torvalds committed
228
laptop-mode.txt
229
	- how to conserve battery power using laptop-mode.
Linus Torvalds's avatar
Linus Torvalds committed
230 231
ldm.txt
	- a brief description of LDM (Windows Dynamic Disks).
232 233 234 235 236 237
leds-class.txt
	- documents LED handling under Linux.
local_ops.txt
	- semantics and behavior of local atomic operations.
lockdep-design.txt
	- documentation on the runtime locking correctness validator.
Linus Torvalds's avatar
Linus Torvalds committed
238
logo.gif
239
	- full colour GIF image of Linux logo (penguin - Tux).
Linus Torvalds's avatar
Linus Torvalds committed
240
logo.txt
241
	- info on creator of above logo & site to get additional images from.
Linus Torvalds's avatar
Linus Torvalds committed
242 243 244 245 246 247 248 249
m68k/
	- directory with info about Linux on Motorola 68k architecture.
magic-number.txt
	- list of magic numbers used to mark/protect kernel data structures.
mca.txt
	- info on supporting Micro Channel Architecture (e.g. PS/2) systems.
md.txt
	- info on boot arguments for the multiple devices driver.
250 251
memory-barriers.txt
	- info on Linux kernel memory barriers.
252 253
memory-hotplug.txt
	- Hotpluggable memory support, how to use and current status.
Linus Torvalds's avatar
Linus Torvalds committed
254 255 256 257 258 259 260
memory.txt
	- info on typical Linux memory problems.
mips/
	- directory with info about Linux on MIPS architecture.
mono.txt
	- how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
moxa-smartio
261
	- file with info on installing/using Moxa multiport serial driver.
Linus Torvalds's avatar
Linus Torvalds committed
262 263
mtrr.txt
	- how to use PPro Memory Type Range Registers to increase performance.
264 265
mutex-design.txt
	- info on the generic mutex subsystem.
266 267
namespaces/
	- directory with various information about namespaces
Linus Torvalds's avatar
Linus Torvalds committed
268 269
nbd.txt
	- info on a TCP implementation of a network block device.
Paul Moore's avatar
Paul Moore committed
270 271
netlabel/
	- directory with information on the NetLabel subsystem.
Linus Torvalds's avatar
Linus Torvalds committed
272 273 274 275 276 277
networking/
	- directory with info on various aspects of networking with Linux.
nfsroot.txt
	- short guide on setting up a diskless box with NFS root filesystem.
nmi_watchdog.txt
	- info on NMI watchdog for SMP systems.
278 279
nommu-mmap.txt
	- documentation about no-mmu memory mapping support.
Linus Torvalds's avatar
Linus Torvalds committed
280 281 282 283 284 285 286 287 288 289 290 291
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.
paride.txt
	- information about the parallel port IDE subsystem.
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.
292 293
pci-error-recovery.txt
	- info on PCI error recovery.
Linus Torvalds's avatar
Linus Torvalds committed
294 295
pci.txt
	- info on the PCI subsystem for device driver authors.
296 297 298 299 300 301
pcieaer-howto.txt
	- the PCI Express Advanced Error Reporting Driver Guide HOWTO.
pcmcia/
	- info on the Linux PCMCIA driver.
pi-futex.txt
	- documentation on lightweight PI-futexes.
Linus Torvalds's avatar
Linus Torvalds committed
302 303 304 305
pm.txt
	- info on Linux power management support.
pnp.txt
	- Linux Plug and Play documentation.
306 307
power_supply_class.txt
	- Tells userspace about battery, UPS, AC or DC power supply properties
Linus Torvalds's avatar
Linus Torvalds committed
308 309 310 311 312 313
power/
	- directory with info on Linux PCI power management.
powerpc/
	- directory with info on using Linux with the PowerPC.
preempt-locking.txt
	- info on locking under a preemptive kernel.
314 315
prio_tree.txt
	- info on radix-priority-search-tree use for indexing vmas.
Linus Torvalds's avatar
Linus Torvalds committed
316 317
ramdisk.txt
	- short guide on how to set up and use the RAM disk.
318 319
rbtree.txt
	- info on what red-black trees are and what they are for.
Linus Torvalds's avatar
Linus Torvalds committed
320 321
riscom8.txt
	- notes on using the RISCom/8 multi-port serial driver.
322 323 324 325
robust-futex-ABI.txt
	- documentation of the robust futex ABI.
robust-futexes.txt
	- a description of what robust futexes are.
Linus Torvalds's avatar
Linus Torvalds committed
326 327 328 329
rocket.txt
	- info on the Comtrol RocketPort multiport serial driver.
rpc-cache.txt
	- introduction to the caching mechanisms in the sunrpc layer.
330 331 332 333
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
334 335 336 337
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.
338 339
scheduler/
	- directory with info on the scheduler.
Linus Torvalds's avatar
Linus Torvalds committed
340 341 342 343 344 345
scsi/
	- directory with info on Linux scsi support.
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.
346 347
sgi-ioc4.txt
	- description of the SGI IOC4 PCI (multi function) device.
Linus Torvalds's avatar
Linus Torvalds committed
348 349 350 351 352 353
sgi-visws.txt
	- short blurb on the SGI Visual Workstations.
sh/
	- directory with info on porting Linux to a new architecture.
smart-config.txt
	- description of the Smart Config makefile feature.
354 355
sony-laptop.txt
	- Sony Notebook Control Driver (SNC) Readme.
Linus Torvalds's avatar
Linus Torvalds committed
356 357 358 359 360 361
sonypi.txt
	- info on Linux Sony Programmable I/O Device support.
sound/
	- directory with info on sound card support.
sparc/
	- directory with info on using Linux on Sparc architecture.
362 363
sparse.txt
	- info on how to obtain and use the sparse tool for typechecking.
Linus Torvalds's avatar
Linus Torvalds committed
364 365
specialix.txt
	- info on hardware/driver for specialix IO8+ multiport serial card.
366 367
spi/
	- overview of Linux kernel Serial Peripheral Interface (SPI) support.
Linus Torvalds's avatar
Linus Torvalds committed
368 369
spinlocks.txt
	- info on using spinlocks to provide exclusive access in kernel.
370 371 372 373
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.
Linus Torvalds's avatar
Linus Torvalds committed
374 375 376 377
stallion.txt
	- info on using the Stallion multiport serial driver.
svga.txt
	- short guide on selecting video modes at boot via VGA BIOS.
378 379
sysfs-rules.txt
	- How not to use sysfs.
Linus Torvalds's avatar
Linus Torvalds committed
380 381 382 383 384 385 386 387
sx.txt
	- info on the Specialix SX/SI multiport serial driver.
sysctl/
	- directory with info on the /proc/sys/* files.
sysrq.txt
	- info on the magic SysRq key.
telephony/
	- directory with info on telephony (e.g. voice over IP) support.
388 389
thinkpad-acpi.txt
	- information on the (IBM and Lenovo) ThinkPad ACPI Extras driver.
Linus Torvalds's avatar
Linus Torvalds committed
390 391 392 393 394 395 396
time_interpolators.txt
	- info on time interpolators.
tipar.txt
	- information about Parallel link cable for Texas Instruments handhelds.
tty.txt
	- guide to the locking policies of the tty layer.
uml/
397
	- directory with information about User Mode Linux.
398 399 400 401
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
402 403
usb/
	- directory with info regarding the Universal Serial Bus.
404 405
video-output.txt
	- sysfs class driver interface to enable/disable a video output device.
Linus Torvalds's avatar
Linus Torvalds committed
406 407 408 409
video4linux/
	- directory with info regarding video/TV/radio cards and linux.
vm/
	- directory with info on the Linux vm code.
410 411
volatile-considered-harmful.txt
	- Why the "volatile" type class should not be used
Linus Torvalds's avatar
Linus Torvalds committed
412 413
voyager.txt
	- guide to running Linux on the Voyager architecture.
414 415
w1/
	- directory with documents regarding the 1-wire (w1) subsystem.
Linus Torvalds's avatar
Linus Torvalds committed
416 417 418 419 420 421
watchdog/
	- how to auto-reboot Linux if it has "fallen and can't get up". ;-)
x86_64/
	- directory with info on Linux support for AMD x86-64 (Hammer) machines.
zorro.txt
	- info on writing drivers for Zorro bus devices found on Amigas.