annotate index.html @ 5:804450b5a73c

Add a blame tag.
author Rob Landley <rob@landley.net>
date Tue, 03 Jul 2007 15:40:41 -0400
parents cadb995e0167
children c751b140afbd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
1 <title>Linux Kernel Documentation</title>
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
2
3
a7c92ed87817 Various updates, mention internationalization, etc.
Rob Landley <rob@landley.net>
parents: 0
diff changeset
3 <h2>Sources of documentation</h2>
a7c92ed87817 Various updates, mention internationalization, etc.
Rob Landley <rob@landley.net>
parents: 0
diff changeset
4
0
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
5 <ul>
3
a7c92ed87817 Various updates, mention internationalization, etc.
Rob Landley <rob@landley.net>
parents: 0
diff changeset
6 <li><a href=Documentation>Text files in the kernel's Documentation directory.</a></li>
a7c92ed87817 Various updates, mention internationalization, etc.
Rob Landley <rob@landley.net>
parents: 0
diff changeset
7 <li><a href=htmldocs>Output of kernel's "make htmldocs".</a></li>
a7c92ed87817 Various updates, mention internationalization, etc.
Rob Landley <rob@landley.net>
parents: 0
diff changeset
8 <li><a href=xmlman>html conversion of man-pages package</a></li>
0
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
9 <li><a href=http://lwn.net/Kernel/Index/>Linux Weekly News kernel articles</a></li>
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
10 <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>
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
11 <li><a href=ols>Ottawa Linux Symposium papers</li>
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
12 <li><a href=http://www.ibm.com/developerworks/views/linux/library.jsp>IBM Developerworks Linux Library</a></li>
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
13 <li><a href=http://www.tux.org/lkml/>Linux Kernel Mailing List FAQ</a></li>
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
14 <li><a href=http://kernelplanet.org>Kernel Planet (blog aggregator)</a></li>
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
15 </ul>
3
a7c92ed87817 Various updates, mention internationalization, etc.
Rob Landley <rob@landley.net>
parents: 0
diff changeset
16
0
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
17 <p>Standards</p>
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
18 <ul>
3
a7c92ed87817 Various updates, mention internationalization, etc.
Rob Landley <rob@landley.net>
parents: 0
diff changeset
19 <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>
0
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
20 <li><a href=http://www.linux-foundation.org/spec/refspecs/>Linux Foundation's specs page</a> (ELF, Dwarf, ABI...)</li>
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
21 </ul>
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
22
3
a7c92ed87817 Various updates, mention internationalization, etc.
Rob Landley <rob@landley.net>
parents: 0
diff changeset
23 <h2>Translations</h2>
a7c92ed87817 Various updates, mention internationalization, etc.
Rob Landley <rob@landley.net>
parents: 0
diff changeset
24 <ul>
a7c92ed87817 Various updates, mention internationalization, etc.
Rob Landley <rob@landley.net>
parents: 0
diff changeset
25 <li><a href=http://tlktp.sourceforge.net/>Linux Kernel Translation Project</a></li>
a7c92ed87817 Various updates, mention internationalization, etc.
Rob Landley <rob@landley.net>
parents: 0
diff changeset
26 <li><a href=http://www.linux.or.jp/JF/index.html>Japanese</a></li>
a7c92ed87817 Various updates, mention internationalization, etc.
Rob Landley <rob@landley.net>
parents: 0
diff changeset
27 </ul>
a7c92ed87817 Various updates, mention internationalization, etc.
Rob Landley <rob@landley.net>
parents: 0
diff changeset
28
0
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
29 <p>todo</p>
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
30 <ul>
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
31 <li><a href=index>Index of terms used by the kernel</a></li>
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
32 </ul>
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
33
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
34 <!--
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
35 http://www.ibm.com/developerworks/linux/library/l-linux-kernel/
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
36 -->
4
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
37 <title>Linux Kernel Documentation</title>
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
38
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
39 <h1>Topics</h1>
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
40
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
41 <pre>
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
42 Building from source
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
43 Configuring, building, Installing, running, debugging
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
44 User interface
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
45 infrastructure (kbuild, tmppiggy)
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
46 Cross compiling, building out of tree, UML, QEMU
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
47
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
48 Source code layout
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
49 Following the boot
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
50 Major subsystems
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
51 Architectures
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
52
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
53 Infrastructure
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
54 Process Scheduler
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
55 fork, exec, sleep
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
56 Timers
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
57 Interrupt handling
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
58 memory management
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
59 mmap, DMA
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
60 vfs
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
61 Filesystems
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
62 Types of filesystems
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
63 Block backed
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
64 Ram backed
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
65 Synthetic
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
66 /proc /sys symfs usbfs devpts
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
67 Network
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
68 FUSE
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
69 Filesystem drivers
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
70 Drivers:
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
71 Filesystem
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
72 Block (block layer, scsi layer)
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
73 Character (tty, audio, null, random/urandom, zero)
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
74 DRI
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
75 Hotplug
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
76 Input core.
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
77 Network
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
78 Modules
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
79 EXPORT_SYMBOL, EXPORT_SYMBOL_GPL
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
80 Busses
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
81 API (how userspace talks to the kernel)
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
82 Syscalls, ioctls
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
83 executable file formats
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
84 a.out, elf, #! flat misc
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
85 css, bss,
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
86 Device nodes
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
87 Pipes (new pipe infrastructure)
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
88 Synthetic filesystems
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
89
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
90 Hardware:
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
91 Architectures
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
92 echo include/asm-* | sed 's@include/asm-@@g'
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
93 generic, uml
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
94 x86, x86-64 powerpc/ppc arm mips sparc sh 68k/coldfire
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
95 DMA, IRQ, MMU (mmap), IOMMU, port I/O
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
96 Busses.
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
97 PCI, USB
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
98
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
99 A working Linux root filesystem.
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
100 Bootloader, kernel
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
101 finding root
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
102 initramfs, switch_root vs pivot_root, /dev/console
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
103 init program and PID 1
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
104 What does daemonizing mean?
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
105 C library, Dynamic loader
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
106 FHS directories
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
107 populating /dev from sysfs.
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
108
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
109 Submitting Patches
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
110
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
111 Following Linux development
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
112 Distros do it for you.
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
113 CATB
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
114 http://vger.kernel.org/vger-lists.html
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
115 http://www.tux.org/lkml/
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
116 lwn, kernel traffic, kernelplanet.
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
117 http://www.kernel.org/faq
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
118 http://www.kernel.org/kdist/rss.xml
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
119 git/mercurial
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
120 Documentation/{CodingStyle,SubmitChecklist}
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
121 The four layer (developer, maintainer, subsystem, linus) model.
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
122
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
123 Politics
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
124 Stable API nonsense
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
125 Why reiser4 not in.
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
126
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
127 Glossary
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
128 </pre>
5
804450b5a73c Add a blame tag.
Rob Landley <rob@landley.net>
parents: 4
diff changeset
129
804450b5a73c Add a blame tag.
Rob Landley <rob@landley.net>
parents: 4
diff changeset
130 <p>This page maintained by Rob Landley <rob@landley.net>.</p>