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