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