Documentation/00-INDEX

   1
   2 This is a brief list of all the files in ./linux/Documentation and what
   3 they contain. If you add a documentation file, please list it here in
   4 alphabetical order as well, or risk being hunted down like a rabid dog.
   5 Please try and keep the descriptions small enough to fit on one line.
   6                                                          Thanks -- Paul G.
   7
   8 Following translations are available on the WWW:
   9
  10    - Japanese, maintained by the JF Project (JF@linux.or.jp), at
  11      http://www.linux.or.jp/JF/
  12
  13 00-INDEX
  14         - this file.
  15 ABI/
  16         - info on kernel <-> userspace ABI and relative interface stability.
  17
  18 BUG-HUNTING
  19         - brute force method of doing binary search of patches to find bug.
  20 Changes
  21         - list of changes that break older software packages.
  22 CodingStyle
  23         - how the boss likes the C code in the kernel to look.
  24 DMA-API.txt
  25         - DMA API, pci_ API & extensions for non-consistent memory machines.
  26 DMA-ISA-LPC.txt
  27         - How to do DMA with ISA (and LPC) devices.
  28 DocBook/
  29         - directory with DocBook templates etc. for kernel documentation.
  30 HOWTO
  31         - the process and procedures of how to do Linux kernel development.
  32 IO-mapping.txt
  33         - how to access I/O mapped memory from within device drivers.
  34 IPMI.txt
  35         - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
  36 IRQ-affinity.txt
  37         - how to select which CPU(s) handle which interrupt events on SMP.
  38 IRQ.txt
  39         - description of what an IRQ is.
  40 ManagementStyle
  41         - how to (attempt to) manage kernel hackers.
  42 MSI-HOWTO.txt
  43         - the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ.
  44 RCU/
  45         - directory with info on RCU (read-copy update).
  46 README.DAC960
  47         - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux.
  48 README.cycladesZ
  49         - info on Cyclades-Z firmware loading.
  50 SAK.txt
  51         - info on Secure Attention Keys.
  52 SM501.txt
  53         - Silicon Motion SM501 multimedia companion chip
  54 SecurityBugs
  55         - procedure for reporting security bugs found in the kernel.
  56 SubmitChecklist
  57         - Linux kernel patch submission checklist.
  58 SubmittingDrivers
  59         - procedure to get a new driver source included into the kernel tree.
  60 SubmittingPatches
  61         - procedure to get a source patch included into the kernel tree.
  62 VGA-softcursor.txt
  63         - how to change your VGA cursor from a blinking underscore.
  64 accounting/
  65         - documentation on accounting and taskstats.
  66 acpi/
  67         - info on ACPI-specific hooks in the kernel.
  68 aoe/
  69         - description of AoE (ATA over Ethernet) along with config examples.
  70 applying-patches.txt
  71         - description of various trees and how to apply their patches.
  72 arm/
  73         - directory with info about Linux on the ARM architecture.
  74 atomic_ops.txt
  75         - semantics and behavior of atomic and bitmask operations.
  76 auxdisplay/
  77         - misc. LCD driver documentation (cfag12864b, ks0108).
  78 basic_profiling.txt
  79         - basic instructions for those who wants to profile Linux kernel.
  80 binfmt_misc.txt
  81         - info on the kernel support for extra binary formats.
  82 blackfin/
  83         - directory with documentation for the Blackfin arch.
  84 block/
  85         - info on the Block I/O (BIO) layer.
  86 cachetlb.txt
  87         - describes the cache/TLB flushing interfaces Linux uses.
  88 cciss.txt
  89         - info, major/minor #'s for Compaq's SMART Array Controllers.
  90 cdrom/
  91         - directory with information on the CD-ROM drivers that Linux has.
  92 cli-sti-removal.txt
  93         - cli()/sti() removal guide.
  94 computone.txt
  95         - info on Computone Intelliport II/Plus Multiport Serial Driver.
  96 connector/
  97         - docs on the netlink based userspace<->kernel space communication mod.
  98 console/
  99         - documentation on Linux console drivers.
 100 cpqarray.txt
 101         - info on using Compaq's SMART2 Intelligent Disk Array Controllers.
 102 cpu-freq/
 103         - info on CPU frequency and voltage scaling.
 104 cpu-hotplug.txt
 105         - document describing CPU hotplug support in the Linux kernel.
 106 cpu-load.txt
 107         - document describing how CPU load statistics are collected.
 108 cpuidle/
 109         - info on CPU_IDLE, CPU idle state management subsystem.
 110 cpusets.txt
 111         - documents the cpusets feature; assign CPUs and Mem to a set of tasks.
 112 cputopology.txt
 113         - documentation on how CPU topology info is exported via sysfs.
 114 cris/
 115         - directory with info about Linux on CRIS architecture.
 116 crypto/
 117         - directory with info on the Crypto API.
 118 dcdbas.txt
 119         - information on the Dell Systems Management Base Driver.
 120 debugging-modules.txt
 121         - some notes on debugging modules after Linux 2.6.3.
 122 dell_rbu.txt
 123         - document demonstrating the use of the Dell Remote BIOS Update driver.
 124 device-mapper/
 125         - directory with info on Device Mapper.
 126 devices.txt
 127         - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
 128 digiepca.txt
 129         - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
 130 dontdiff
 131         - file containing a list of files that should never be diff'ed.
 132 driver-model/
 133         - directory with info about Linux driver model.
 134 dvb/
 135         - info on Linux Digital Video Broadcast (DVB) subsystem.
 136 early-userspace/
 137         - info about initramfs, klibc, and userspace early during boot.
 138 edac.txt
 139         - information on EDAC - Error Detection And Correction
 140 eisa.txt
 141         - info on EISA bus support.
 142 exception.txt
 143         - how Linux v2.2 handles exceptions without verify_area etc.
 144 fault-injection/
 145         - dir with docs about the fault injection capabilities infrastructure.
 146 fb/
 147         - directory with info on the frame buffer graphics abstraction layer.
 148 feature-removal-schedule.txt
 149         - list of files and features that are going to be removed.
 150 filesystems/
 151         - info on the vfs and the various filesystems that Linux supports.
 152 firmware_class/
 153         - request_firmware() hotplug interface info.
 154 floppy.txt
 155         - notes and driver options for the floppy disk driver.
 156 frv/
 157         - Fujitsu FR-V Linux documentation.
 158 gpio.txt
 159         - overview of GPIO (General Purpose Input/Output) access conventions.
 160 hayes-esp.txt
 161         - info on using the Hayes ESP serial driver.
 162 highuid.txt
 163         - notes on the change from 16 bit to 32 bit user/group IDs.
 164 hpet.txt
 165         - High Precision Event Timer Driver for Linux.
 166 timers/
 167         - info on the timer related topics
 168 hw_random.txt
 169         - info on Linux support for random number generator in i8xx chipsets.
 170 hwmon/
 171         - directory with docs on various hardware monitoring drivers.
 172 i2c/
 173         - directory with info about the I2C bus/protocol (2 wire, kHz speed).
 174 i2o/
 175         - directory with info about the Linux I2O subsystem.
 176 i386/
 177         - directory with info about Linux on Intel 32 bit architecture.
 178 ia64/
 179         - directory with info about Linux on Intel 64 bit architecture.
 180 infiniband/
 181         - directory with documents concerning Linux InfiniBand support.
 182 initrd.txt
 183         - how to use the RAM disk as an initial/temporary root filesystem.
 184 input/
 185         - info on Linux input device support.
 186 io_ordering.txt
 187         - info on ordering I/O writes to memory-mapped addresses.
 188 ioctl/
 189         - directory with documents describing various IOCTL calls.
 190 ioctl-number.txt
 191         - how to implement and register device/driver ioctl calls.
 192 iostats.txt
 193         - info on I/O statistics Linux kernel provides.
 194 irqflags-tracing.txt
 195         - how to use the irq-flags tracing feature.
 196 isapnp.txt
 197         - info on Linux ISA Plug & Play support.
 198 isdn/
 199         - directory with info on the Linux ISDN support, and supported cards.
 200 java.txt
 201         - info on the in-kernel binary support for Java(tm).
 202 kbuild/
 203         - directory with info about the kernel build process.
 204 kdump/
 205         - directory with mini HowTo on getting the crash dump code to work.
 206 kernel-doc-nano-HOWTO.txt
 207         - mini HowTo on generation and location of kernel documentation files.
 208 kernel-docs.txt
 209         - listing of various WWW + books that document kernel internals.
 210 kernel-parameters.txt
 211         - summary listing of command line / boot prompt args for the kernel.
 212 keys-request-key.txt
 213         - description of the kernel key request service.
 214 keys.txt
 215         - description of the kernel key retention service.
 216 kobject.txt
 217         - info of the kobject infrastructure of the Linux kernel.
 218 kprobes.txt
 219         - documents the kernel probes debugging feature.
 220 kref.txt
 221         - docs on adding reference counters (krefs) to kernel objects.
 222 laptops/
 223         - directory with laptop related info and laptop driver documentation.
 224 ldm.txt
 225         - a brief description of LDM (Windows Dynamic Disks).
 226 leds-class.txt
 227         - documents LED handling under Linux.
 228 local_ops.txt
 229         - semantics and behavior of local atomic operations.
 230 lockdep-design.txt
 231         - documentation on the runtime locking correctness validator.
 232 logo.gif
 233         - full colour GIF image of Linux logo (penguin - Tux).
 234 logo.txt
 235         - info on creator of above logo & site to get additional images from.
 236 m68k/
 237         - directory with info about Linux on Motorola 68k architecture.
 238 magic-number.txt
 239         - list of magic numbers used to mark/protect kernel data structures.
 240 mca.txt
 241         - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
 242 md.txt
 243         - info on boot arguments for the multiple devices driver.
 244 memory-barriers.txt
 245         - info on Linux kernel memory barriers.
 246 memory-hotplug.txt
 247         - Hotpluggable memory support, how to use and current status.
 248 memory.txt
 249         - info on typical Linux memory problems.
 250 mips/
 251         - directory with info about Linux on MIPS architecture.
 252 mono.txt
 253         - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
 254 moxa-smartio
 255         - file with info on installing/using Moxa multiport serial driver.
 256 mtrr.txt
 257         - how to use PPro Memory Type Range Registers to increase performance.
 258 mutex-design.txt
 259         - info on the generic mutex subsystem.
 260 namespaces/
 261         - directory with various information about namespaces
 262 nbd.txt
 263         - info on a TCP implementation of a network block device.
 264 netlabel/
 265         - directory with information on the NetLabel subsystem.
 266 networking/
 267         - directory with info on various aspects of networking with Linux.
 268 nmi_watchdog.txt
 269         - info on NMI watchdog for SMP systems.
 270 nommu-mmap.txt
 271         - documentation about no-mmu memory mapping support.
 272 numastat.txt
 273         - info on how to read Numa policy hit/miss statistics in sysfs.
 274 oops-tracing.txt
 275         - how to decode those nasty internal kernel error dump messages.
 276 paride.txt
 277         - information about the parallel port IDE subsystem.
 278 parisc/
 279         - directory with info on using Linux on PA-RISC architecture.
 280 parport.txt
 281         - how to use the parallel-port driver.
 282 parport-lowlevel.txt
 283         - description and usage of the low level parallel port functions.
 284 pcmcia/
 285         - info on the Linux PCMCIA driver.
 286 pi-futex.txt
 287         - documentation on lightweight PI-futexes.
 288 pnp.txt
 289         - Linux Plug and Play documentation.
 290 power/
 291         - directory with info on Linux PCI power management.
 292 powerpc/
 293         - directory with info on using Linux with the PowerPC.
 294 preempt-locking.txt
 295         - info on locking under a preemptive kernel.
 296 prio_tree.txt
 297         - info on radix-priority-search-tree use for indexing vmas.
 298 ramdisk.txt
 299         - short guide on how to set up and use the RAM disk.
 300 rbtree.txt
 301         - info on what red-black trees are and what they are for.
 302 riscom8.txt
 303         - notes on using the RISCom/8 multi-port serial driver.
 304 robust-futex-ABI.txt
 305         - documentation of the robust futex ABI.
 306 robust-futexes.txt
 307         - a description of what robust futexes are.
 308 rocket.txt
 309         - info on the Comtrol RocketPort multiport serial driver.
 310 rt-mutex-design.txt
 311         - description of the RealTime mutex implementation design.
 312 rt-mutex.txt
 313         - desc. of RT-mutex subsystem with PI (Priority Inheritance) support.
 314 rtc.txt
 315         - notes on how to use the Real Time Clock (aka CMOS clock) driver.
 316 s390/
 317         - directory with info on using Linux on the IBM S390.
 318 scheduler/
 319         - directory with info on the scheduler.
 320 scsi/
 321         - directory with info on Linux scsi support.
 322 serial/
 323         - directory with info on the low level serial API.
 324 serial-console.txt
 325         - how to set up Linux with a serial line console as the default.
 326 sgi-ioc4.txt
 327         - description of the SGI IOC4 PCI (multi function) device.
 328 sgi-visws.txt
 329         - short blurb on the SGI Visual Workstations.
 330 sh/
 331         - directory with info on porting Linux to a new architecture.
 332 sound/
 333         - directory with info on sound card support.
 334 sparc/
 335         - directory with info on using Linux on Sparc architecture.
 336 sparse.txt
 337         - info on how to obtain and use the sparse tool for typechecking.
 338 specialix.txt
 339         - info on hardware/driver for specialix IO8+ multiport serial card.
 340 spi/
 341         - overview of Linux kernel Serial Peripheral Interface (SPI) support.
 342 spinlocks.txt
 343         - info on using spinlocks to provide exclusive access in kernel.
 344 stable_api_nonsense.txt
 345         - info on why the kernel does not have a stable in-kernel api or abi.
 346 stable_kernel_rules.txt
 347         - rules and procedures for the -stable kernel releases.
 348 stallion.txt
 349         - info on using the Stallion multiport serial driver.
 350 svga.txt
 351         - short guide on selecting video modes at boot via VGA BIOS.
 352 sysfs-rules.txt
 353         - How not to use sysfs.
 354 sx.txt
 355         - info on the Specialix SX/SI multiport serial driver.
 356 sysctl/
 357         - directory with info on the /proc/sys/* files.
 358 sysrq.txt
 359         - info on the magic SysRq key.
 360 telephony/
 361         - directory with info on telephony (e.g. voice over IP) support.
 362 time_interpolators.txt
 363         - info on time interpolators.
 364 tty.txt
 365         - guide to the locking policies of the tty layer.
 366 uml/
 367         - directory with information about User Mode Linux.
 368 unicode.txt
 369         - info on the Unicode character/font mapping used in Linux.
 370 unshare.txt
 371         - description of the Linux unshare system call.
 372 usb/
 373         - directory with info regarding the Universal Serial Bus.
 374 video-output.txt
 375         - sysfs class driver interface to enable/disable a video output device.
 376 video4linux/
 377         - directory with info regarding video/TV/radio cards and linux.
 378 vm/
 379         - directory with info on the Linux vm code.
 380 volatile-considered-harmful.txt
 381         - Why the "volatile" type class should not be used
 382 voyager.txt
 383         - guide to running Linux on the Voyager architecture.
 384 w1/
 385         - directory with documents regarding the 1-wire (w1) subsystem.
 386 watchdog/
 387         - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
 388 x86_64/
 389         - directory with info on Linux support for AMD x86-64 (Hammer) machines.
 390 zorro.txt
 391         - info on writing drivers for Zorro bus devices found on Amigas.