aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJesper Juhl <jesper.juhl@gmail.com>2007-07-16 02:41:41 -0400
committerLinus Torvalds <torvalds@woody.linux-foundation.org>2007-07-16 12:05:51 -0400
commitf6b07d39d7904ceecac53699d6b5ddd677304880 (patch)
tree88e56acc37a9f49a58f8435341f1fdbf5f0e429d
parent2618c60b8b5836b73e8deb385a036820744d256d (diff)
Add missing files and dirs to 00-INDEX in Documentation/
Add descriptions for a number of missing files and directories to the Documentation/00-INDEX file. Signed-off-by: Jesper Juhl <jesper.juhl@gmail.com> Acked-by: Rob Landley <rob@landley.net> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
-rw-r--r--Documentation/00-INDEX142
1 files changed, 133 insertions, 9 deletions
diff --git a/Documentation/00-INDEX b/Documentation/00-INDEX
index f08ca9535733..8b0563633442 100644
--- a/Documentation/00-INDEX
+++ b/Documentation/00-INDEX
@@ -12,6 +12,8 @@ Following translations are available on the WWW:
12 12
1300-INDEX 1300-INDEX
14 - this file. 14 - this file.
15ABI/
16 - info on kernel <-> userspace ABI and relative interface stability.
15BUG-HUNTING 17BUG-HUNTING
16 - brute force method of doing binary search of patches to find bug. 18 - brute force method of doing binary search of patches to find bug.
17Changes 19Changes
@@ -25,37 +27,57 @@ DMA-mapping.txt
25DocBook/ 27DocBook/
26 - directory with DocBook templates etc. for kernel documentation. 28 - directory with DocBook templates etc. for kernel documentation.
27HOWTO 29HOWTO
28 - The process and procedures of how to do Linux kernel development. 30 - the process and procedures of how to do Linux kernel development.
29IO-mapping.txt 31IO-mapping.txt
30 - how to access I/O mapped memory from within device drivers. 32 - how to access I/O mapped memory from within device drivers.
31IPMI.txt 33IPMI.txt
32 - info on Linux Intelligent Platform Management Interface (IPMI) Driver. 34 - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
33IRQ-affinity.txt 35IRQ-affinity.txt
34 - how to select which CPU(s) handle which interrupt events on SMP. 36 - how to select which CPU(s) handle which interrupt events on SMP.
37IRQ.txt
38 - description of what an IRQ is.
35ManagementStyle 39ManagementStyle
36 - how to (attempt to) manage kernel hackers. 40 - how to (attempt to) manage kernel hackers.
37MSI-HOWTO.txt 41MSI-HOWTO.txt
38 - the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ. 42 - the Message Signaled Interrupts (MSI) Driver Guide HOWTO and FAQ.
43PCIEBUS-HOWTO.txt
44 - a guide describing the PCI Express Port Bus driver.
39RCU/ 45RCU/
40 - directory with info on RCU (read-copy update). 46 - directory with info on RCU (read-copy update).
41README.DAC960 47README.DAC960
42 - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux. 48 - info on Mylex DAC960/DAC1100 PCI RAID Controller Driver for Linux.
49README.cycladesZ
50 - info on Cyclades-Z firmware loading.
43SAK.txt 51SAK.txt
44 - info on Secure Attention Keys. 52 - info on Secure Attention Keys.
53SecurityBugs
54 - procedure for reporting security bugs found in the kernel.
55SubmitChecklist
56 - Linux kernel patch submission checklist.
45SubmittingDrivers 57SubmittingDrivers
46 - procedure to get a new driver source included into the kernel tree. 58 - procedure to get a new driver source included into the kernel tree.
47SubmittingPatches 59SubmittingPatches
48 - procedure to get a source patch included into the kernel tree. 60 - procedure to get a source patch included into the kernel tree.
49VGA-softcursor.txt 61VGA-softcursor.txt
50 - how to change your VGA cursor from a blinking underscore. 62 - how to change your VGA cursor from a blinking underscore.
63accounting/
64 - documentation on accounting and taskstats.
65aoe/
66 - description of AoE (ATA over Ethernet) along with config examples.
51applying-patches.txt 67applying-patches.txt
52 - description of various trees and how to apply their patches. 68 - description of various trees and how to apply their patches.
53arm/ 69arm/
54 - directory with info about Linux on the ARM architecture. 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).
55basic_profiling.txt 75basic_profiling.txt
56 - basic instructions for those who wants to profile Linux kernel. 76 - basic instructions for those who wants to profile Linux kernel.
57binfmt_misc.txt 77binfmt_misc.txt
58 - info on the kernel support for extra binary formats. 78 - info on the kernel support for extra binary formats.
79blackfin/
80 - directory with documentation for the Blackfin arch.
59block/ 81block/
60 - info on the Block I/O (BIO) layer. 82 - info on the Block I/O (BIO) layer.
61cachetlb.txt 83cachetlb.txt
@@ -68,16 +90,32 @@ cli-sti-removal.txt
68 - cli()/sti() removal guide. 90 - cli()/sti() removal guide.
69computone.txt 91computone.txt
70 - info on Computone Intelliport II/Plus Multiport Serial Driver. 92 - info on Computone Intelliport II/Plus Multiport Serial Driver.
93connector/
94 - docs on the netlink based userspace<->kernel space communication mod.
95console/
96 - documentation on Linux console drivers.
71cpqarray.txt 97cpqarray.txt
72 - info on using Compaq's SMART2 Intelligent Disk Array Controllers. 98 - info on using Compaq's SMART2 Intelligent Disk Array Controllers.
73cpu-freq/ 99cpu-freq/
74 - info on CPU frequency and voltage scaling. 100 - info on CPU frequency and voltage scaling.
101cpu-hotplug.txt
102 - document describing CPU hotplug support in the Linux kernel.
103cpu-load.txt
104 - document describing how CPU load statistics are collected.
105cpusets.txt
106 - documents the cpusets feature; assign CPUs and Mem to a set of tasks.
107cputopology.txt
108 - documentation on how CPU topology info is exported via sysfs.
75cris/ 109cris/
76 - directory with info about Linux on CRIS architecture. 110 - directory with info about Linux on CRIS architecture.
77crypto/ 111crypto/
78 - directory with info on the Crypto API. 112 - directory with info on the Crypto API.
113dcdbas.txt
114 - information on the Dell Systems Management Base Driver.
79debugging-modules.txt 115debugging-modules.txt
80 - some notes on debugging modules after Linux 2.6.3. 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.
81device-mapper/ 119device-mapper/
82 - directory with info on Device Mapper. 120 - directory with info on Device Mapper.
83devices.txt 121devices.txt
@@ -86,32 +124,52 @@ digiepca.txt
86 - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards. 124 - info on Digi Intl. {PC,PCI,EISA}Xx and Xem series cards.
87dnotify.txt 125dnotify.txt
88 - info about directory notification in Linux. 126 - info about directory notification in Linux.
127dontdiff
128 - file containing a list of files that should never be diff'ed.
89driver-model/ 129driver-model/
90 - directory with info about Linux driver model. 130 - directory with info about Linux driver model.
131drivers/
132 - directory with driver documentation (currently only EDAC).
91dvb/ 133dvb/
92 - info on Linux Digital Video Broadcast (DVB) subsystem. 134 - info on Linux Digital Video Broadcast (DVB) subsystem.
93early-userspace/ 135early-userspace/
94 - info about initramfs, klibc, and userspace early during boot. 136 - info about initramfs, klibc, and userspace early during boot.
137ecryptfs.txt
138 - docs on eCryptfs: stacked cryptographic filesystem for Linux.
95eisa.txt 139eisa.txt
96 - info on EISA bus support. 140 - info on EISA bus support.
97exception.txt 141exception.txt
98 - how Linux v2.2 handles exceptions without verify_area etc. 142 - how Linux v2.2 handles exceptions without verify_area etc.
143fault-injection/
144 - dir with docs about the fault injection capabilities infrastructure.
99fb/ 145fb/
100 - directory with info on the frame buffer graphics abstraction layer. 146 - directory with info on the frame buffer graphics abstraction layer.
147feature-removal-schedule.txt
148 - list of files and features that are going to be removed.
101filesystems/ 149filesystems/
102 - directory with info on the various filesystems that Linux supports. 150 - directory with info on the various filesystems that Linux supports.
103firmware_class/ 151firmware_class/
104 - request_firmware() hotplug interface info. 152 - request_firmware() hotplug interface info.
105floppy.txt 153floppy.txt
106 - notes and driver options for the floppy disk driver. 154 - notes and driver options for the floppy disk driver.
155fujitsu/
156 - Fujitsu FR-V Linux documentation.
157gpio.txt
158 - overview of GPIO (General Purpose Input/Output) access conventions.
107hayes-esp.txt 159hayes-esp.txt
108 - info on using the Hayes ESP serial driver. 160 - info on using the Hayes ESP serial driver.
109highuid.txt 161highuid.txt
110 - notes on the change from 16 bit to 32 bit user/group IDs. 162 - notes on the change from 16 bit to 32 bit user/group IDs.
111hpet.txt 163hpet.txt
112 - High Precision Event Timer Driver for Linux. 164 - High Precision Event Timer Driver for Linux.
165hrtimer/
166 - info on the timer_stats debugging facility for timer (ab)use.
167hrtimers/
168 - info on the hrtimers subsystem for high-resolution kernel timers.
113hw_random.txt 169hw_random.txt
114 - info on Linux support for random number generator in i8xx chipsets. 170 - info on Linux support for random number generator in i8xx chipsets.
171hwmon/
172 - directory with docs on various hardware monitoring drivers.
115i2c/ 173i2c/
116 - directory with info about the I2C bus/protocol (2 wire, kHz speed). 174 - directory with info about the I2C bus/protocol (2 wire, kHz speed).
117i2o/ 175i2o/
@@ -122,16 +180,22 @@ ia64/
122 - directory with info about Linux on Intel 64 bit architecture. 180 - directory with info about Linux on Intel 64 bit architecture.
123ide.txt 181ide.txt
124 - important info for users of ATA devices (IDE/EIDE disks and CD-ROMS). 182 - important info for users of ATA devices (IDE/EIDE disks and CD-ROMS).
183infiniband/
184 - directory with documents concerning Linux InfiniBand support.
125initrd.txt 185initrd.txt
126 - how to use the RAM disk as an initial/temporary root filesystem. 186 - how to use the RAM disk as an initial/temporary root filesystem.
127input/ 187input/
128 - info on Linux input device support. 188 - info on Linux input device support.
129io_ordering.txt 189io_ordering.txt
130 - info on ordering I/O writes to memory-mapped addresses. 190 - info on ordering I/O writes to memory-mapped addresses.
191ioctl/
192 - directory with documents describing various IOCTL calls.
131ioctl-number.txt 193ioctl-number.txt
132 - how to implement and register device/driver ioctl calls. 194 - how to implement and register device/driver ioctl calls.
133iostats.txt 195iostats.txt
134 - info on I/O statistics Linux kernel provides. 196 - info on I/O statistics Linux kernel provides.
197irqflags-tracing.txt
198 - how to use the irq-flags tracing feature.
135isapnp.txt 199isapnp.txt
136 - info on Linux ISA Plug & Play support. 200 - info on Linux ISA Plug & Play support.
137isdn/ 201isdn/
@@ -140,26 +204,40 @@ java.txt
140 - info on the in-kernel binary support for Java(tm). 204 - info on the in-kernel binary support for Java(tm).
141kbuild/ 205kbuild/
142 - directory with info about the kernel build process. 206 - directory with info about the kernel build process.
143kdumpt.txt 207kdump/
144 - mini HowTo on getting the crash dump code to work. 208 - directory with mini HowTo on getting the crash dump code to work.
145kernel-doc-nano-HOWTO.txt 209kernel-doc-nano-HOWTO.txt
146 - mini HowTo on generation and location of kernel documentation files. 210 - mini HowTo on generation and location of kernel documentation files.
147kernel-docs.txt 211kernel-docs.txt
148 - listing of various WWW + books that document kernel internals. 212 - listing of various WWW + books that document kernel internals.
149kernel-parameters.txt 213kernel-parameters.txt
150 - summary listing of command line / boot prompt args for the kernel. 214 - summary listing of command line / boot prompt args for the kernel.
215keys-request-key.txt
216 - description of the kernel key request service.
217keys.txt
218 - description of the kernel key retention service.
151kobject.txt 219kobject.txt
152 - info of the kobject infrastructure of the Linux kernel. 220 - info of the kobject infrastructure of the Linux kernel.
221kprobes.txt
222 - documents the kernel probes debugging feature.
223kref.txt
224 - docs on adding reference counters (krefs) to kernel objects.
153laptop-mode.txt 225laptop-mode.txt
154 - How to conserve battery power using laptop-mode. 226 - how to conserve battery power using laptop-mode.
155ldm.txt 227ldm.txt
156 - a brief description of LDM (Windows Dynamic Disks). 228 - a brief description of LDM (Windows Dynamic Disks).
229leds-class.txt
230 - documents LED handling under Linux.
231local_ops.txt
232 - semantics and behavior of local atomic operations.
233lockdep-design.txt
234 - documentation on the runtime locking correctness validator.
157locks.txt 235locks.txt
158 - info on file locking implementations, flock() vs. fcntl(), etc. 236 - info on file locking implementations, flock() vs. fcntl(), etc.
159logo.gif 237logo.gif
160 - Full colour GIF image of Linux logo (penguin). 238 - full colour GIF image of Linux logo (penguin - Tux).
161logo.txt 239logo.txt
162 - Info on creator of above logo & site to get additional images from. 240 - info on creator of above logo & site to get additional images from.
163m68k/ 241m68k/
164 - directory with info about Linux on Motorola 68k architecture. 242 - directory with info about Linux on Motorola 68k architecture.
165magic-number.txt 243magic-number.txt
@@ -170,6 +248,8 @@ mca.txt
170 - info on supporting Micro Channel Architecture (e.g. PS/2) systems. 248 - info on supporting Micro Channel Architecture (e.g. PS/2) systems.
171md.txt 249md.txt
172 - info on boot arguments for the multiple devices driver. 250 - info on boot arguments for the multiple devices driver.
251memory-barriers.txt
252 - info on Linux kernel memory barriers.
173memory.txt 253memory.txt
174 - info on typical Linux memory problems. 254 - info on typical Linux memory problems.
175mips/ 255mips/
@@ -177,9 +257,11 @@ mips/
177mono.txt 257mono.txt
178 - how to execute Mono-based .NET binaries with the help of BINFMT_MISC. 258 - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
179moxa-smartio 259moxa-smartio
180 - info on installing/using Moxa multiport serial driver. 260 - file with info on installing/using Moxa multiport serial driver.
181mtrr.txt 261mtrr.txt
182 - how to use PPro Memory Type Range Registers to increase performance. 262 - how to use PPro Memory Type Range Registers to increase performance.
263mutex-design.txt
264 - info on the generic mutex subsystem.
183nbd.txt 265nbd.txt
184 - info on a TCP implementation of a network block device. 266 - info on a TCP implementation of a network block device.
185netlabel/ 267netlabel/
@@ -190,6 +272,8 @@ nfsroot.txt
190 - short guide on setting up a diskless box with NFS root filesystem. 272 - short guide on setting up a diskless box with NFS root filesystem.
191nmi_watchdog.txt 273nmi_watchdog.txt
192 - info on NMI watchdog for SMP systems. 274 - info on NMI watchdog for SMP systems.
275nommu-mmap.txt
276 - documentation about no-mmu memory mapping support.
193numastat.txt 277numastat.txt
194 - info on how to read Numa policy hit/miss statistics in sysfs. 278 - info on how to read Numa policy hit/miss statistics in sysfs.
195oops-tracing.txt 279oops-tracing.txt
@@ -202,8 +286,16 @@ parport.txt
202 - how to use the parallel-port driver. 286 - how to use the parallel-port driver.
203parport-lowlevel.txt 287parport-lowlevel.txt
204 - description and usage of the low level parallel port functions. 288 - description and usage of the low level parallel port functions.
289pci-error-recovery.txt
290 - info on PCI error recovery.
205pci.txt 291pci.txt
206 - info on the PCI subsystem for device driver authors. 292 - info on the PCI subsystem for device driver authors.
293pcieaer-howto.txt
294 - the PCI Express Advanced Error Reporting Driver Guide HOWTO.
295pcmcia/
296 - info on the Linux PCMCIA driver.
297pi-futex.txt
298 - documentation on lightweight PI-futexes.
207pm.txt 299pm.txt
208 - info on Linux power management support. 300 - info on Linux power management support.
209pnp.txt 301pnp.txt
@@ -214,18 +306,32 @@ powerpc/
214 - directory with info on using Linux with the PowerPC. 306 - directory with info on using Linux with the PowerPC.
215preempt-locking.txt 307preempt-locking.txt
216 - info on locking under a preemptive kernel. 308 - info on locking under a preemptive kernel.
309prio_tree.txt
310 - info on radix-priority-search-tree use for indexing vmas.
217ramdisk.txt 311ramdisk.txt
218 - short guide on how to set up and use the RAM disk. 312 - short guide on how to set up and use the RAM disk.
313rbtree.txt
314 - info on what red-black trees are and what they are for.
219riscom8.txt 315riscom8.txt
220 - notes on using the RISCom/8 multi-port serial driver. 316 - notes on using the RISCom/8 multi-port serial driver.
317robust-futex-ABI.txt
318 - documentation of the robust futex ABI.
319robust-futexes.txt
320 - a description of what robust futexes are.
221rocket.txt 321rocket.txt
222 - info on the Comtrol RocketPort multiport serial driver. 322 - info on the Comtrol RocketPort multiport serial driver.
223rpc-cache.txt 323rpc-cache.txt
224 - introduction to the caching mechanisms in the sunrpc layer. 324 - introduction to the caching mechanisms in the sunrpc layer.
325rt-mutex-design.txt
326 - description of the RealTime mutex implementation design.
327rt-mutex.txt
328 - desc. of RT-mutex subsystem with PI (Priority Inheritance) support.
225rtc.txt 329rtc.txt
226 - notes on how to use the Real Time Clock (aka CMOS clock) driver. 330 - notes on how to use the Real Time Clock (aka CMOS clock) driver.
227s390/ 331s390/
228 - directory with info on using Linux on the IBM S390. 332 - directory with info on using Linux on the IBM S390.
333sched-arch.txt
334 - CPU Scheduler implementation hints for architecture specific code.
229sched-coding.txt 335sched-coding.txt
230 - reference for various scheduler-related methods in the O(1) scheduler. 336 - reference for various scheduler-related methods in the O(1) scheduler.
231sched-design.txt 337sched-design.txt
@@ -240,22 +346,32 @@ serial/
240 - directory with info on the low level serial API. 346 - directory with info on the low level serial API.
241serial-console.txt 347serial-console.txt
242 - how to set up Linux with a serial line console as the default. 348 - how to set up Linux with a serial line console as the default.
349sgi-ioc4.txt
350 - description of the SGI IOC4 PCI (multi function) device.
243sgi-visws.txt 351sgi-visws.txt
244 - short blurb on the SGI Visual Workstations. 352 - short blurb on the SGI Visual Workstations.
245sh/ 353sh/
246 - directory with info on porting Linux to a new architecture. 354 - directory with info on porting Linux to a new architecture.
355sharedsubtree.txt
356 - a description of shared subtrees for namespaces.
247smart-config.txt 357smart-config.txt
248 - description of the Smart Config makefile feature. 358 - description of the Smart Config makefile feature.
249smp.txt 359smp.txt
250 - a few notes on symmetric multi-processing. 360 - a few notes on symmetric multi-processing.
361sony-laptop.txt
362 - Sony Notebook Control Driver (SNC) Readme.
251sonypi.txt 363sonypi.txt
252 - info on Linux Sony Programmable I/O Device support. 364 - info on Linux Sony Programmable I/O Device support.
253sound/ 365sound/
254 - directory with info on sound card support. 366 - directory with info on sound card support.
255sparc/ 367sparc/
256 - directory with info on using Linux on Sparc architecture. 368 - directory with info on using Linux on Sparc architecture.
369sparse.txt
370 - info on how to obtain and use the sparse tool for typechecking.
257specialix.txt 371specialix.txt
258 - info on hardware/driver for specialix IO8+ multiport serial card. 372 - info on hardware/driver for specialix IO8+ multiport serial card.
373spi/
374 - overview of Linux kernel Serial Peripheral Interface (SPI) support.
259spinlocks.txt 375spinlocks.txt
260 - info on using spinlocks to provide exclusive access in kernel. 376 - info on using spinlocks to provide exclusive access in kernel.
261stable_api_nonsense.txt 377stable_api_nonsense.txt
@@ -274,24 +390,32 @@ sysrq.txt
274 - info on the magic SysRq key. 390 - info on the magic SysRq key.
275telephony/ 391telephony/
276 - directory with info on telephony (e.g. voice over IP) support. 392 - directory with info on telephony (e.g. voice over IP) support.
393thinkpad-acpi.txt
394 - information on the (IBM and Lenovo) ThinkPad ACPI Extras driver.
277time_interpolators.txt 395time_interpolators.txt
278 - info on time interpolators. 396 - info on time interpolators.
279tipar.txt 397tipar.txt
280 - information about Parallel link cable for Texas Instruments handhelds. 398 - information about Parallel link cable for Texas Instruments handhelds.
281tty.txt 399tty.txt
282 - guide to the locking policies of the tty layer. 400 - guide to the locking policies of the tty layer.
283unicode.txt
284 - info on the Unicode character/font mapping used in Linux.
285uml/ 401uml/
286 - directory with information about User Mode Linux. 402 - directory with information about User Mode Linux.
403unicode.txt
404 - info on the Unicode character/font mapping used in Linux.
405unshare.txt
406 - description of the Linux unshare system call.
287usb/ 407usb/
288 - directory with info regarding the Universal Serial Bus. 408 - directory with info regarding the Universal Serial Bus.
409video-output.txt
410 - sysfs class driver interface to enable/disable a video output device.
289video4linux/ 411video4linux/
290 - directory with info regarding video/TV/radio cards and linux. 412 - directory with info regarding video/TV/radio cards and linux.
291vm/ 413vm/
292 - directory with info on the Linux vm code. 414 - directory with info on the Linux vm code.
293voyager.txt 415voyager.txt
294 - guide to running Linux on the Voyager architecture. 416 - guide to running Linux on the Voyager architecture.
417w1/
418 - directory with documents regarding the 1-wire (w1) subsystem.
295watchdog/ 419watchdog/
296 - how to auto-reboot Linux if it has "fallen and can't get up". ;-) 420 - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
297x86_64/ 421x86_64/