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