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.
15BUG-HUNTING
16 - brute force method of doing binary search of patches to find bug.
17Changes
18 - list of changes that break older software packages.
19CodingStyle
20 - how the boss likes the C code in the kernel to look.
21DMA-API.txt
22 - DMA API, pci_ API & extensions for non-consistent memory machines.
23DMA-mapping.txt
24 - info for PCI drivers using DMA portably across all platforms.
25DocBook/
26 - directory with DocBook templates etc. for kernel documentation.
27IO-mapping.txt
28 - how to access I/O mapped memory from within device drivers.
29IPMI.txt
30 - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
31IRQ-affinity.txt
32 - how to select which CPU(s) handle which interrupt events on SMP.
33ManagementStyle
34 - how to (attempt to) manage kernel hackers.
35MSI-HOWTO.txt
36 - the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ.
37RCU/
38 - directory with info on RCU (read-copy update).
39README.DAC960
40 - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux.
41SAK.txt
42 - info on Secure Attention Keys.
43SubmittingDrivers
44 - procedure to get a new driver source included into the kernel tree.
45SubmittingPatches
46 - procedure to get a source patch included into the kernel tree.
47VGA-softcursor.txt
48 - how to change your VGA cursor from a blinking underscore.
49arm/
50 - directory with info about Linux on the ARM architecture.
51basic_profiling.txt
52 - basic instructions for those who wants to profile Linux kernel.
53binfmt_misc.txt
54 - info on the kernel support for extra binary formats.
55block/
56 - info on the Block I/O (BIO) layer.
57cachetlb.txt
58 - describes the cache/TLB flushing interfaces Linux uses.
59cciss.txt
60 - info, major/minor #'s for Compaq's SMART Array Controllers.
61cdrom/
62 - directory with information on the CD-ROM drivers that Linux has.
63cli-sti-removal.txt
64 - cli()/sti() removal guide.
65computone.txt
66 - info on Computone Intelliport II/Plus Multiport Serial Driver.
67cpqarray.txt
68 - info on using Compaq's SMART2 Intelligent Disk Array Controllers.
69cpu-freq/
70 - info on CPU frequency and voltage scaling.
71cris/
72 - directory with info about Linux on CRIS architecture.
73crypto/
74 - directory with info on the Crypto API.
75debugging-modules.txt
76 - some notes on debugging modules after Linux 2.6.3.
77device-mapper/
78 - directory with info on Device Mapper.
79devices.txt
80 - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
81digiepca.txt
82 - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
83dnotify.txt
84 - info about directory notification in Linux.
85driver-model/
86 - directory with info about Linux driver model.
87dvb/
88 - info on Linux Digital Video Broadcast (DVB) subsystem.
89early-userspace/
90 - info about initramfs, klibc, and userspace early during boot.
91eisa.txt
92 - info on EISA bus support.
93exception.txt
94 - how Linux v2.2 handles exceptions without verify_area etc.
95fb/
96 - directory with info on the frame buffer graphics abstraction layer.
97filesystems/
98 - directory with info on the various filesystems that Linux supports.
99firmware_class/
100 - request_firmware() hotplug interface info.
101floppy.txt
102 - notes and driver options for the floppy disk driver.
103ftape.txt
104 - notes about the floppy tape device driver.
105hayes-esp.txt
106 - info on using the Hayes ESP serial driver.
107highuid.txt
108 - notes on the change from 16 bit to 32 bit user/group IDs.
109hpet.txt
110 - High Precision Event Timer Driver for Linux.
111hw_random.txt
112 - info on Linux support for random number generator in i8xx chipsets.
113i2c/
114 - directory with info about the I2C bus/protocol (2 wire, kHz speed).
115i2o/
116 - directory with info about the Linux I2O subsystem.
117i386/
118 - directory with info about Linux on Intel 32 bit architecture.
119ia64/
120 - directory with info about Linux on Intel 64 bit architecture.
121ide.txt
122 - important info for users of ATA devices (IDE/EIDE disks and CD-ROMS).
123initrd.txt
124 - how to use the RAM disk as an initial/temporary root filesystem.
125input/
126 - info on Linux input device support.
127io_ordering.txt
128 - info on ordering I/O writes to memory-mapped addresses.
129ioctl-number.txt
130 - how to implement and register device/driver ioctl calls.
131iostats.txt
132 - info on I/O statistics Linux kernel provides.
133isapnp.txt
134 - info on Linux ISA Plug & Play support.
135isdn/
136 - directory with info on the Linux ISDN support, and supported cards.
137java.txt
138 - info on the in-kernel binary support for Java(tm).
139kbuild/
140 - directory with info about the kernel build process.
141kdumpt.txt
142 - mini HowTo on getting the crash dump code to work.
143kernel-doc-nano-HOWTO.txt
144 - mini HowTo on generation and location of kernel documentation files.
145kernel-docs.txt
146 - listing of various WWW + books that document kernel internals.
147kernel-parameters.txt
148 - summary listing of command line / boot prompt args for the kernel.
149kobject.txt
150 - info of the kobject infrastructure of the Linux kernel.
151laptop-mode.txt
152 - How to conserve battery power using laptop-mode.
153ldm.txt
154 - a brief description of LDM (Windows Dynamic Disks).
155locks.txt
156 - info on file locking implementations, flock() vs. fcntl(), etc.
157logo.gif
158 - Full colour GIF image of Linux logo (penguin).
159logo.txt
160 - Info on creator of above logo & site to get additional images from.
161m68k/
162 - directory with info about Linux on Motorola 68k architecture.
163magic-number.txt
164 - list of magic numbers used to mark/protect kernel data structures.
165mandatory.txt
166 - info on the Linux implementation of Sys V mandatory file locking.
167mca.txt
168 - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
169md.txt
170 - info on boot arguments for the multiple devices driver.
171memory.txt
172 - info on typical Linux memory problems.
173mips/
174 - directory with info about Linux on MIPS architecture.
175mono.txt
176 - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
177moxa-smartio
178 - info on installing/using Moxa multiport serial driver.
179mtrr.txt
180 - how to use PPro Memory Type Range Registers to increase performance.
181nbd.txt
182 - info on a TCP implementation of a network block device.
183networking/
184 - directory with info on various aspects of networking with Linux.
185nfsroot.txt
186 - short guide on setting up a diskless box with NFS root filesystem.
187nmi_watchdog.txt
188 - info on NMI watchdog for SMP systems.
189numastat.txt
190 - info on how to read Numa policy hit/miss statistics in sysfs.
191oops-tracing.txt
192 - how to decode those nasty internal kernel error dump messages.
193paride.txt
194 - information about the parallel port IDE subsystem.
195parisc/
196 - directory with info on using Linux on PA-RISC architecture.
197parport.txt
198 - how to use the parallel-port driver.
199parport-lowlevel.txt
200 - description and usage of the low level parallel port functions.
201pci.txt
202 - info on the PCI subsystem for device driver authors.
203pm.txt
204 - info on Linux power management support.
205pnp.txt
206 - Linux Plug and Play documentation.
207power/
208 - directory with info on Linux PCI power management.
209powerpc/
210 - directory with info on using Linux with the PowerPC.
211preempt-locking.txt
212 - info on locking under a preemptive kernel.
213ramdisk.txt
214 - short guide on how to set up and use the RAM disk.
215riscom8.txt
216 - notes on using the RISCom/8 multi-port serial driver.
217rocket.txt
218 - info on the Comtrol RocketPort multiport serial driver.
219rpc-cache.txt
220 - introduction to the caching mechanisms in the sunrpc layer.
221rtc.txt
222 - notes on how to use the Real Time Clock (aka CMOS clock) driver.
223s390/
224 - directory with info on using Linux on the IBM S390.
225sched-coding.txt
226 - reference for various scheduler-related methods in the O(1) scheduler.
227sched-design.txt
228 - goals, design and implementation of the Linux O(1) scheduler.
229sched-domains.txt
230 - information on scheduling domains.
231sched-stats.txt
232 - information on schedstats (Linux Scheduler Statistics).
233scsi/
234 - directory with info on Linux scsi support.
235serial/
236 - directory with info on the low level serial API.
237serial-console.txt
238 - how to set up Linux with a serial line console as the default.
239sgi-visws.txt
240 - short blurb on the SGI Visual Workstations.
241sh/
242 - directory with info on porting Linux to a new architecture.
243smart-config.txt
244 - description of the Smart Config makefile feature.
245smp.txt
246 - a few notes on symmetric multi-processing.
247sonypi.txt
248 - info on Linux Sony Programmable I/O Device support.
249sound/
250 - directory with info on sound card support.
251sparc/
252 - directory with info on using Linux on Sparc architecture.
253specialix.txt
254 - info on hardware/driver for specialix IO8+ multiport serial card.
255spinlocks.txt
256 - info on using spinlocks to provide exclusive access in kernel.
257stallion.txt
258 - info on using the Stallion multiport serial driver.
259svga.txt
260 - short guide on selecting video modes at boot via VGA BIOS.
261sx.txt
262 - info on the Specialix SX/SI multiport serial driver.
263sysctl/
264 - directory with info on the /proc/sys/* files.
265sysrq.txt
266 - info on the magic SysRq key.
267telephony/
268 - directory with info on telephony (e.g. voice over IP) support.
269time_interpolators.txt
270 - info on time interpolators.
271tipar.txt
272 - information about Parallel link cable for Texas Instruments handhelds.
273tty.txt
274 - guide to the locking policies of the tty layer.
275unicode.txt
276 - info on the Unicode character/font mapping used in Linux.
277uml/
278 - directory with infomation about User Mode Linux.
279usb/
280 - directory with info regarding the Universal Serial Bus.
281video4linux/
282 - directory with info regarding video/TV/radio cards and linux.
283vm/
284 - directory with info on the Linux vm code.
285voyager.txt
286 - guide to running Linux on the Voyager architecture.
287watchdog/
288 - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
289x86_64/
290 - directory with info on Linux support for AMD x86-64 (Hammer) machines.
291xterm-linux.xpm
292 - XPM image of penguin logo (see logo.txt) sitting on an xterm.
293zorro.txt
294 - info on writing drivers for Zorro bus devices found on Amigas.