<title>Linux Kernel Documentation</title>

<h2>Sources of documentation</h2>

<ul>
<li><a href=Documentation>Text files in the kernel's Documentation directory.</a></li>
<li><a href=htmldocs>Output of kernel's "make htmldocs".</a></li>
<li><a href=xmlman>html conversion of man-pages package</a></li>
<li><a href=http://lwn.net/Kernel/Index/>Linux Weekly News kernel articles</a></li>
<li>Linux Device Drivers book (<a href=http://lwn.net/Kernel/LDD3/>third edition</a>) (<a href=http://www.xml.com/ldd/chapter/book/>second edition</a>)</li>
<li><a href=ols>Ottawa Linux Symposium papers</li>
<li><a href=http://www.ibm.com/developerworks/views/linux/library.jsp>IBM Developerworks Linux Library</a></li>
<li><a href=http://www.tux.org/lkml/>Linux Kernel Mailing List FAQ</a></li>
<li><a href=http://kernelplanet.org>Kernel Planet (blog aggregator)</a></li>
</ul>

<p>Standards</p>
<ul>
<li><a href=http://www.opengroup.org/onlinepubs/009695399/>Single Unix Specification v3</a> (Also known as Open Group Base Specifications issue 6, and closely overlapping with Posix.  See especially <a href=http://www.opengroup.org/onlinepubs/009695399/idx/xsh.html>system interfaces</a>)</li>
<li><a href=http://www.linux-foundation.org/spec/refspecs/>Linux Foundation's specs page</a> (ELF, Dwarf, ABI...)</li>
</ul>

<h2>Translations</h2>
<ul>
<li><a href=http://tlktp.sourceforge.net/>Linux Kernel Translation Project</a></li>
<li><a href=http://www.linux.or.jp/JF/index.html>Japanese</a></li>
</ul>

<p>todo</p>
<ul>
<li><a href=index>Index of terms used by the kernel</a></li>
</ul>

<!--
http://www.ibm.com/developerworks/linux/library/l-linux-kernel/
-->
<title>Linux Kernel Documentation</title>

<h1>Topics</h1>

<pre>
Building from source
   Configuring, building, Installing, running, debugging
     User interface
     infrastructure (kbuild, tmppiggy)
   Cross compiling, building out of tree, UML, QEMU

Source code layout
  Following the boot
  Major subsystems
  Architectures

Infrastructure
  Process Scheduler
    fork, exec, sleep
  Timers
    Interrupt handling
  memory management
    mmap, DMA
  vfs
    Filesystems
      Types of filesystems
        Block backed
        Ram backed
        Synthetic
          /proc /sys symfs usbfs devpts
        Network
          FUSE
      Filesystem drivers
  Drivers:
    Filesystem
    Block (block layer, scsi layer)
    Character (tty, audio, null, random/urandom, zero)
    DRI
  Hotplug
  Input core.
  Network
  Modules
    EXPORT_SYMBOL, EXPORT_SYMBOL_GPL
  Busses
  API (how userspace talks to the kernel)
    Syscalls, ioctls
    executable file formats
      a.out, elf, #! flat misc
        css, bss, 
    Device nodes
    Pipes (new pipe infrastructure)
    Synthetic filesystems

Hardware:
  Architectures
    echo include/asm-* | sed 's@include/asm-@@g'
    generic, uml
    x86, x86-64 powerpc/ppc arm mips sparc sh 68k/coldfire
  DMA, IRQ, MMU (mmap), IOMMU, port I/O
  Busses.
    PCI, USB

A working Linux root filesystem.
  Bootloader, kernel
  finding root
    initramfs, switch_root vs pivot_root, /dev/console
  init program and PID 1
    What does daemonizing mean?
  C library, Dynamic loader
  FHS directories
    populating /dev from sysfs.

Submitting Patches

Following Linux development
  Distros do it for you.
  CATB
  http://vger.kernel.org/vger-lists.html
  http://www.tux.org/lkml/
  lwn, kernel traffic, kernelplanet.
  http://www.kernel.org/faq
    http://www.kernel.org/kdist/rss.xml
  git/mercurial
  Documentation/{CodingStyle,SubmitChecklist}
  The four layer (developer, maintainer, subsystem, linus) model.

  Politics
    Stable API nonsense
    Why reiser4 not in.

Glossary
</pre>

<p>This page maintained by Rob Landley <rob@landley.net>.</p>