annotate index.html @ 6:c751b140afbd

Chinese documentation link suggested by LeoLi@freescale.com
author Rob Landley <rob@landley.net>
date Tue, 10 Jul 2007 12:17:12 -0400
parents 804450b5a73c
children 7caa68027a70
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>
6
c751b140afbd Chinese documentation link suggested by LeoLi@freescale.com
Rob Landley <rob@landley.net>
parents: 5
diff changeset
27 <li><a href=http://zh-kernel.org/docs>Chinese</a></li>
3
a7c92ed87817 Various updates, mention internationalization, etc.
Rob Landley <rob@landley.net>
parents: 0
diff changeset
28 </ul>
a7c92ed87817 Various updates, mention internationalization, etc.
Rob Landley <rob@landley.net>
parents: 0
diff changeset
29
0
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
30 <p>todo</p>
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
31 <ul>
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
32 <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
33 </ul>
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 <!--
93c7869166a0 Source control would probably be a good idea.
Rob Landley <rob@landley.net>
parents:
diff changeset
36 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
37 -->
4
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
38 <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
39
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
40 <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
41
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
42 <pre>
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
43 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
44 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
45 User interface
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
46 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
47 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
48
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
49 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
50 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
51 Major subsystems
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
52 Architectures
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
53
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
54 Infrastructure
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
55 Process Scheduler
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
56 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
57 Timers
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
58 Interrupt handling
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
59 memory management
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
60 mmap, DMA
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
61 vfs
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
62 Filesystems
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
63 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
64 Block backed
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
65 Ram backed
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
66 Synthetic
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
67 /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
68 Network
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
69 FUSE
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
70 Filesystem drivers
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
71 Drivers:
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
72 Filesystem
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
73 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
74 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
75 DRI
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
76 Hotplug
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
77 Input core.
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
78 Network
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
79 Modules
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
80 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
81 Busses
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
82 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
83 Syscalls, ioctls
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
84 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
85 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
86 css, bss,
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
87 Device nodes
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
88 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
89 Synthetic filesystems
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
90
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
91 Hardware:
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
92 Architectures
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
93 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
94 generic, uml
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
95 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
96 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
97 Busses.
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
98 PCI, USB
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
99
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
100 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
101 Bootloader, kernel
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
102 finding root
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
103 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
104 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
105 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
106 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
107 FHS directories
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
108 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
109
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
110 Submitting Patches
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
111
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
112 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
113 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
114 CATB
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
115 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
116 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
117 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
118 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
119 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
120 git/mercurial
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
121 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
122 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
123
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
124 Politics
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
125 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
126 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
127
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
128 Glossary
cadb995e0167 Add random stab at topic outline, a skeleton to hang stuff on.
Rob Landley <rob@landley.net>
parents: 3
diff changeset
129 </pre>
5
804450b5a73c Add a blame tag.
Rob Landley <rob@landley.net>
parents: 4
diff changeset
130
804450b5a73c Add a blame tag.
Rob Landley <rob@landley.net>
parents: 4
diff changeset
131 <p>This page maintained by Rob Landley <rob@landley.net>.</p>