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