view index.html @ 117:7d33366e569e

Note L: list entries, and change email address back.
author Rob Landley <rob@landley.net>
date Tue, 03 May 2011 12:16:51 -0500
parents 185c8f72730e
children 9a8b11877d11
line wrap: on
line source

<html>
<title>Linux Kernel Documentation</title>
<body>

<h2>Documentation extracted from the Linux kernel and mirrored on the web where
Google can find it:</h2>
<ul>
<li><p><a href=Documentation>Documentation</a> - Text files in the kernel source tarball's Documentation subdirectory.</p></li>
<li><p><a href=htmldocs>htmldocs</a> - Kernel Documentation maintained in docbook format (output of "make htmldocs").</p></li>
<li><p><a href=menuconfig>Menuconfig</a> - help text for each kernel configuration option (from kconfig source).</p></li>

<li><p><a href=readme>README</a> various README files scattered around Linux kernel source</a></p></li>
<li><p><a href=rfc-linux.html>RFC</a> - List of IETF RFCs referred to by kernel source files.  Links to both the text of the RFC and the source files that refer to it.</a></p></li>
<li><p><a href=makehelp.txt>Output of kernel's "make help".</a></p></li>
</ul>

<h2>Standards documents applicable to the Linux kernel</h2>
<ul>
<li><p><a href=http://www.opengroup.org/onlinepubs/9699919799/>Single Unix Specification v4</a> (Also known as Open Group Base Specifications issue 7, and POSIX 2008.  See especially <a href=http://www.opengroup.org/onlinepubs/9699919799/idx/xsh.html>system interfaces</a>)</p></li>

<li><p>C99 standard (current version of the C programming language): <a href=http://www.open-std.org/jtc1/sc22/wg14/www/standards>ISO/IEC C9899 PDF</a>, <a href=http://busybox.net/~landley/c99-draft.html>html</a>, or <a href=http://c0x.coding-guidelines.com/>searchable website</a>.</p></li>
<li><p><a href=http://www.unix.org/whitepapers/64bit.html>LP64 standard</a> defining the size of char, short, int, and long on 32-bit and 64-bit platforms.  (See also the <a href=http://www.unix.org/version2/whatsnew/lp64_wp.html>rationale</a> for the standard, and the <a href=http://blogs.msdn.com/oldnewthing/archive/2005/01/31/363790.aspx>legacy reasons</a> another OS declined to adopt this standard).</p></li>

<li><p><a href=http://refspecs.linuxfoundation.org/index.shtml>Linux Foundation's specs page</a> (ELF, Dwarf, ABI...)</p></li>
<li><p><a href="http://www.t10.org/scsi-3.htm">SCSI standards</a></p></li>
</ul>

<h2>Other web pages containing kernel documentation</h2>
<ul>
<li><p><a href=ols>Ottawa Linux Symposium papers, split up and indexed by year</a></p></li>
<li><a href=http://kernel.org/doc/man-pages>Linux man-pages website, includes HTML versions of man pages</a></li>
<li><p><a href=http://vger.kernel.org/vger-lists.html>Development mailing lists available on kernel.org</a></p>
<ul><li>See also the L: entries in <a href=linux/MAINTAINERS>MAINTAINERS</a></li></ul>
</li>

<li><p><a href=http://lwn.net/Kernel/Index/>All Linux Weekly News kernel articles</a> indexed by topic<p></li>
<li><p><a href=http://www.linuxjournal.com/xstatic/magazine/archives>Linux Journal archives</a></p></li>
<li><p><a href=http://twitter.com/kernellog2>H-Online's Kernel-Log</a> (most recent first)</p></li>
<li><p>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>)</p></li>
<li><p><a href=http://www.ibm.com/developerworks/views/linux/library.jsp>IBM Developerworks Linux Library</a> (also <a href=http://www.ibm.com/developerworks/linux/library/l-linux-kernel/>here</a>)</p></li>

<li><p><a href=http://www.tux.org/lkml/>Linux Kernel Mailing List FAQ</a></p></li>
<li><p><a href=http://kernelplanet.org>Kernel Planet (blog aggregator)</a></p></li>
<li><p><a href=video.html>A few videos of interest</a></p></li>
<li><p><a href=local>Some locally produced docs</a></p></li>
<li><p><a href=als1999>Atlanta Linux Showcase CD (1999)</a></p></li>
</ul>

<h2>Translations to other languages</h2>
<ul>
<li><p><a href=http://tlktp.sourceforge.net/>Linux Kernel Translation Project</a></p></li>

<li><p><a href=http://kernelnewbies.org/RegionalNewbies>Kernel Newbies regional pages</a></p></li>
<li><p><a href=http://www.linux.or.jp/JF/index.html>Japanese</a></p></li>
<li><p><a href=http://zh-kernel.org/docs>Chinese</a></p></li>
</ul>

<h2>Documentation on memory management</h2>
<ul>
<li><p><a href="gorman">Understanding the Linux Virtual Memory Manager</a>, online book by Mel Gorman.</p></li>
<li><p>What every programmer should know about memory, article series by Ulrich Drepper,
parts
<a href=http://lwn.net/Articles/250967/>one</a>,

<a href=http://lwn.net/Articles/252125/>two</a>,
<a href=http://lwn.net/Articles/253361/>three</a>,
<a href=http://lwn.net/Articles/254445/>four</a>,
<a href=http://lwn.net/Articles/255364/>five</a>.
</p></li>
<li><p>Ars technica ram guide, article series by Jon "Hannibal" Stokes, parts
<a href=http://arstechnica.com/paedia/r/ram_guide/ram_guide.part1-1.html>one</a>,
<a href=http://arstechnica.com/paedia/r/ram_guide/ram_guide.part1-1.html>two</a>,
<a href=http://arstechnica.com/paedia/r/ram_guide/ram_guide.part3-1.html>three</a>,
<a href=http://arstechnica.com/articles/paedia/cpu/caching.ars/1>Cacheing</a>,

<a href=http://arstechnica.com/articles/paedia/cpu/bandwidth-latency.ars>Bandwidth and Latency</a>.</p></li>
</ul>

<h2>Miscelaneous</h2>
<ul>
<li><p><a href=index-old.html>Old index.</a></p></li>
</ul>

<p>Page maintained by Rob Landley, rob at landley dot net.</p>
</body>
</html>