Blame view

Documentation/00-INDEX 11.9 KB
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1
2
3
4
5
6
7
8
9
10
11
12
13
14
  
  This is a brief list of all the files in ./linux/Documentation and what
  they contain. If you add a documentation file, please list it here in
  alphabetical order as well, or risk being hunted down like a rabid dog.
  Please try and keep the descriptions small enough to fit on one line.
  							 Thanks -- Paul G.
  
  Following translations are available on the WWW:
  
     - Japanese, maintained by the JF Project (JF@linux.or.jp), at
       http://www.linux.or.jp/JF/
  
  00-INDEX
  	- this file.
f6b07d39d   Jesper Juhl   Add missing files...
15
16
  ABI/
  	- info on kernel <-> userspace ABI and relative interface stability.
b4d2730a0   Len Brown   ACPI: document me...
17

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