Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
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@linux.or.jp), at
11 http://www.linux.or.jp/JF/
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.
35IO-mapping.txt
36 - how to access I/O mapped memory from within device drivers.
37IPMI.txt
38 - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
39IRQ-affinity.txt
40 - how to select which CPU(s) handle which interrupt events on SMP.
41IRQ.txt
42 - description of what an IRQ is.
43ManagementStyle
44 - how to (attempt to) manage kernel hackers.
45RCU/
46 - directory with info on RCU (read-copy update).
47SAK.txt
48 - info on Secure Attention Keys.
49SM501.txt
50 - Silicon Motion SM501 multimedia companion chip
51SecurityBugs
52 - procedure for reporting security bugs found in the kernel.
53SubmitChecklist
54 - Linux kernel patch submission checklist.
55SubmittingDrivers
56 - procedure to get a new driver source included into the kernel tree.
57SubmittingPatches
58 - procedure to get a source patch included into the kernel tree.
59VGA-softcursor.txt
60 - how to change your VGA cursor from a blinking underscore.
61accounting/
62 - documentation on accounting and taskstats.
63acpi/
64 - info on ACPI-specific hooks in the kernel.
65aoe/
66 - description of AoE (ATA over Ethernet) along with config examples.
67applying-patches.txt
68 - description of various trees and how to apply their patches.
69arm/
70 - directory with info about Linux on the ARM architecture.
71atomic_ops.txt
72 - semantics and behavior of atomic and bitmask operations.
73auxdisplay/
74 - misc. LCD driver documentation (cfag12864b, ks0108).
75basic_profiling.txt
76 - basic instructions for those who wants to profile Linux kernel.
77binfmt_misc.txt
78 - info on the kernel support for extra binary formats.
79blackfin/
80 - directory with documentation for the Blackfin arch.
81block/
82 - info on the Block I/O (BIO) layer.
83blockdev/
84 - info on block devices & drivers
85btmrvl.txt
86 - info on Marvell Bluetooth driver usage.
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.
107cris/
108 - directory with info about Linux on CRIS architecture.
109crypto/
110 - directory with info on the Crypto API.
111dcdbas.txt
112 - information on the Dell Systems Management Base Driver.
113debugging-modules.txt
114 - some notes on debugging modules after Linux 2.6.3.
115dell_rbu.txt
116 - document demonstrating the use of the Dell Remote BIOS Update driver.
117device-mapper/
118 - directory with info on Device Mapper.
119devices.txt
120 - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
121dontdiff
122 - file containing a list of files that should never be diff'ed.
123driver-model/
124 - directory with info about Linux driver model.
125dvb/
126 - info on Linux Digital Video Broadcast (DVB) subsystem.
127early-userspace/
128 - info about initramfs, klibc, and userspace early during boot.
129edac.txt
130 - information on EDAC - Error Detection And Correction
131eisa.txt
132 - info on EISA bus support.
133exception.txt
134 - how Linux v2.2 handles exceptions without verify_area etc.
135fault-injection/
136 - dir with docs about the fault injection capabilities infrastructure.
137fb/
138 - directory with info on the frame buffer graphics abstraction layer.
139feature-removal-schedule.txt
140 - list of files and features that are going to be removed.
141filesystems/
142 - info on the vfs and the various filesystems that Linux supports.
143firmware_class/
144 - request_firmware() hotplug interface info.
145frv/
146 - Fujitsu FR-V Linux documentation.
147gpio.txt
148 - overview of GPIO (General Purpose Input/Output) access conventions.
149highuid.txt
150 - notes on the change from 16 bit to 32 bit user/group IDs.
151timers/
152 - info on the timer related topics
153hw_random.txt
154 - info on Linux support for random number generator in i8xx chipsets.
155hwmon/
156 - directory with docs on various hardware monitoring drivers.
157i2c/
158 - directory with info about the I2C bus/protocol (2 wire, kHz speed).
159i2o/
160 - directory with info about the Linux I2O subsystem.
161x86/i386/
162 - directory with info about Linux on Intel 32 bit architecture.
163ia64/
164 - directory with info about Linux on Intel 64 bit architecture.
165infiniband/
166 - directory with documents concerning Linux InfiniBand support.
167initrd.txt
168 - how to use the RAM disk as an initial/temporary root filesystem.
169input/
170 - info on Linux input device support.
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.
195keys-request-key.txt
196 - description of the kernel key request service.
197keys.txt
198 - description of the kernel key retention service.
199kobject.txt
200 - info of the kobject infrastructure of the Linux kernel.
201kprobes.txt
202 - documents the kernel probes debugging feature.
203kref.txt
204 - docs on adding reference counters (krefs) to kernel objects.
205laptops/
206 - directory with laptop related info and laptop driver documentation.
207ldm.txt
208 - a brief description of LDM (Windows Dynamic Disks).
209leds-class.txt
210 - documents LED handling under Linux.
211local_ops.txt
212 - semantics and behavior of local atomic operations.
213lockdep-design.txt
214 - documentation on the runtime locking correctness validator.
215logo.gif
216 - full colour GIF image of Linux logo (penguin - Tux).
217logo.txt
218 - info on creator of above logo & site to get additional images from.
219m68k/
220 - directory with info about Linux on Motorola 68k architecture.
221magic-number.txt
222 - list of magic numbers used to mark/protect kernel data structures.
223mca.txt
224 - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
225md.txt
226 - info on boot arguments for the multiple devices driver.
227memory-barriers.txt
228 - info on Linux kernel memory barriers.
229memory-hotplug.txt
230 - Hotpluggable memory support, how to use and current status.
231memory.txt
232 - info on typical Linux memory problems.
233mips/
234 - directory with info about Linux on MIPS architecture.
235mono.txt
236 - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
237mutex-design.txt
238 - info on the generic mutex subsystem.
239namespaces/
240 - directory with various information about namespaces
241netlabel/
242 - directory with information on the NetLabel subsystem.
243networking/
244 - directory with info on various aspects of networking with Linux.
245nmi_watchdog.txt
246 - info on NMI watchdog for SMP systems.
247nommu-mmap.txt
248 - documentation about no-mmu memory mapping support.
249numastat.txt
250 - info on how to read Numa policy hit/miss statistics in sysfs.
251oops-tracing.txt
252 - how to decode those nasty internal kernel error dump messages.
253parisc/
254 - directory with info on using Linux on PA-RISC architecture.
255parport.txt
256 - how to use the parallel-port driver.
257parport-lowlevel.txt
258 - description and usage of the low level parallel port functions.
259pcmcia/
260 - info on the Linux PCMCIA driver.
261pi-futex.txt
262 - documentation on lightweight PI-futexes.
263pnp.txt
264 - Linux Plug and Play documentation.
265power/
266 - directory with info on Linux PCI power management.
267powerpc/
268 - directory with info on using Linux with the PowerPC.
269preempt-locking.txt
270 - info on locking under a preemptive kernel.
271printk-formats.txt
272 - how to get printk format specifiers right
273prio_tree.txt
274 - info on radix-priority-search-tree use for indexing vmas.
275rbtree.txt
276 - info on what red-black trees are and what they are for.
277robust-futex-ABI.txt
278 - documentation of the robust futex ABI.
279robust-futexes.txt
280 - a description of what robust futexes are.
281rt-mutex-design.txt
282 - description of the RealTime mutex implementation design.
283rt-mutex.txt
284 - desc. of RT-mutex subsystem with PI (Priority Inheritance) support.
285rtc.txt
286 - notes on how to use the Real Time Clock (aka CMOS clock) driver.
287s390/
288 - directory with info on using Linux on the IBM S390.
289scheduler/
290 - directory with info on the scheduler.
291scsi/
292 - directory with info on Linux scsi support.
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.
327time_interpolators.txt
328 - info on time interpolators.
329uml/
330 - directory with information about User Mode Linux.
331unicode.txt
332 - info on the Unicode character/font mapping used in Linux.
333unshare.txt
334 - description of the Linux unshare system call.
335usb/
336 - directory with info regarding the Universal Serial Bus.
337video-output.txt
338 - sysfs class driver interface to enable/disable a video output device.
339video4linux/
340 - directory with info regarding video/TV/radio cards and linux.
341vm/
342 - directory with info on the Linux vm code.
343volatile-considered-harmful.txt
344 - Why the "volatile" type class should not be used
345voyager.txt
346 - guide to running Linux on the Voyager architecture.
347w1/
348 - directory with documents regarding the 1-wire (w1) subsystem.
349watchdog/
350 - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
351x86/x86_64/
352 - directory with info on Linux support for AMD x86-64 (Hammer) machines.
353zorro.txt
354 - info on writing drivers for Zorro bus devices found on Amigas.