]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | |
2 | This is a brief list of all the files in ./linux/Documentation and what | |
3 | they contain. If you add a documentation file, please list it here in | |
4 | alphabetical order as well, or risk being hunted down like a rabid dog. | |
449e3a72 | 5 | Please keep the descriptions small enough to fit on one line. |
1da177e4 LT |
6 | Thanks -- Paul G. |
7 | ||
8 | Following translations are available on the WWW: | |
9 | ||
010f4564 MI |
10 | - Japanese, maintained by the JF Project (jf@listserv.linux.or.jp), at |
11 | http://linuxjf.sourceforge.jp/ | |
1da177e4 LT |
12 | |
13 | 00-INDEX | |
14 | - this file. | |
f6b07d39 JJ |
15 | ABI/ |
16 | - info on kernel <-> userspace ABI and relative interface stability. | |
1da177e4 LT |
17 | DMA-API.txt |
18 | - DMA API, pci_ API & extensions for non-consistent memory machines. | |
449e3a72 PG |
19 | DMA-API-HOWTO.txt |
20 | - Dynamic DMA mapping Guide | |
5ef43567 RL |
21 | DMA-ISA-LPC.txt |
22 | - How to do DMA with ISA (and LPC) devices. | |
449e3a72 PG |
23 | DMA-attributes.txt |
24 | - listing of the various possible attributes a DMA region can have | |
1da177e4 LT |
25 | DocBook/ |
26 | - directory with DocBook templates etc. for kernel documentation. | |
449e3a72 PG |
27 | EDID/ |
28 | - directory with info on customizing EDID for broken gfx/displays. | |
1da177e4 LT |
29 | IPMI.txt |
30 | - info on Linux Intelligent Platform Management Interface (IPMI) Driver. | |
31 | IRQ-affinity.txt | |
32 | - how to select which CPU(s) handle which interrupt events on SMP. | |
449e3a72 | 33 | IRQ-domain.txt |
453f42d3 | 34 | - info on interrupt numbering and setting up IRQ domains. |
f6b07d39 JJ |
35 | IRQ.txt |
36 | - description of what an IRQ is. | |
449e3a72 PG |
37 | Intel-IOMMU.txt |
38 | - basic info on the Intel IOMMU virtualization support. | |
39 | Makefile | |
f59c668c SK |
40 | - This file does nothing. Removing it breaks make htmldocs and |
41 | make distclean. | |
822d289f MCC |
42 | PCI/ |
43 | - info related to PCI drivers. | |
1da177e4 LT |
44 | RCU/ |
45 | - directory with info on RCU (read-copy update). | |
1da177e4 LT |
46 | SAK.txt |
47 | - info on Secure Attention Keys. | |
5ef43567 RL |
48 | SM501.txt |
49 | - Silicon Motion SM501 multimedia companion chip | |
f6b07d39 JJ |
50 | accounting/ |
51 | - documentation on accounting and taskstats. | |
b4d2730a LB |
52 | acpi/ |
53 | - info on ACPI-specific hooks in the kernel. | |
79c87c30 MCC |
54 | admin-guide/ |
55 | - info related to Linux users and system admins. | |
f6b07d39 JJ |
56 | aoe/ |
57 | - description of AoE (ATA over Ethernet) along with config examples. | |
1da177e4 LT |
58 | arm/ |
59 | - directory with info about Linux on the ARM architecture. | |
449e3a72 PG |
60 | arm64/ |
61 | - directory with info about Linux on the 64 bit ARM architecture. | |
f6b07d39 JJ |
62 | auxdisplay/ |
63 | - misc. LCD driver documentation (cfag12864b, ks0108). | |
449e3a72 PG |
64 | backlight/ |
65 | - directory with info on controlling backlights in flat panel displays | |
3cf8ca1c HA |
66 | bcache.txt |
67 | - Block-layer cache on fast SSDs to improve slow (raid) I/O performance. | |
f6b07d39 JJ |
68 | blackfin/ |
69 | - directory with documentation for the Blackfin arch. | |
1da177e4 LT |
70 | block/ |
71 | - info on the Block I/O (BIO) layer. | |
31c00fc1 RD |
72 | blockdev/ |
73 | - info on block devices & drivers | |
449e3a72 PG |
74 | bt8xxgpio.txt |
75 | - info on how to modify a bt8xx video card for GPIO usage. | |
196be0cd BZ |
76 | btmrvl.txt |
77 | - info on Marvell Bluetooth driver usage. | |
449e3a72 PG |
78 | bus-devices/ |
79 | - directory with info on TI GPMC (General Purpose Memory Controller) | |
9fe41e41 RD |
80 | bus-virt-phys-mapping.txt |
81 | - how to access I/O mapped memory from within device drivers. | |
1da177e4 LT |
82 | cachetlb.txt |
83 | - describes the cache/TLB flushing interfaces Linux uses. | |
1da177e4 LT |
84 | cdrom/ |
85 | - directory with information on the CD-ROM drivers that Linux has. | |
822d289f MCC |
86 | cgroup-v1/ |
87 | - cgroups v1 features, including cpusets and memory controller. | |
88 | cgroup-v2.txt | |
89 | - cgroups v2 features, including cpusets and memory controller. | |
449e3a72 PG |
90 | circular-buffers.txt |
91 | - how to make use of the existing circular buffer infrastructure | |
92 | clk.txt | |
93 | - info on the common clock framework | |
822d289f MCC |
94 | cma/ |
95 | - Continuous Memory Area (CMA) debugfs interface. | |
f6b07d39 JJ |
96 | connector/ |
97 | - docs on the netlink based userspace<->kernel space communication mod. | |
98 | console/ | |
99 | - documentation on Linux console drivers. | |
24755a55 SF |
100 | core-api/ |
101 | - documentation on kernel core components. | |
1da177e4 LT |
102 | cpu-freq/ |
103 | - info on CPU frequency and voltage scaling. | |
f6b07d39 JJ |
104 | cpu-hotplug.txt |
105 | - document describing CPU hotplug support in the Linux kernel. | |
106 | cpu-load.txt | |
107 | - document describing how CPU load statistics are collected. | |
fe8e288a VP |
108 | cpuidle/ |
109 | - info on CPU_IDLE, CPU idle state management subsystem. | |
f6b07d39 JJ |
110 | cputopology.txt |
111 | - documentation on how CPU topology info is exported via sysfs. | |
fbedceb1 BP |
112 | crc32.txt |
113 | - brief tutorial on CRC computation | |
1da177e4 LT |
114 | cris/ |
115 | - directory with info about Linux on CRIS architecture. | |
116 | crypto/ | |
117 | - directory with info on the Crypto API. | |
f6b07d39 JJ |
118 | dcdbas.txt |
119 | - information on the Dell Systems Management Base Driver. | |
1da177e4 LT |
120 | debugging-modules.txt |
121 | - some notes on debugging modules after Linux 2.6.3. | |
449e3a72 PG |
122 | debugging-via-ohci1394.txt |
123 | - how to use firewire like a hardware debugger memory reader. | |
f6b07d39 JJ |
124 | dell_rbu.txt |
125 | - document demonstrating the use of the Dell Remote BIOS Update driver. | |
822d289f MCC |
126 | dev-tools/ |
127 | - directory with info on development tools for the kernel. | |
1da177e4 LT |
128 | device-mapper/ |
129 | - directory with info on Device Mapper. | |
822d289f MCC |
130 | dmaengine/ |
131 | - the DMA engine and controller API guides. | |
449e3a72 PG |
132 | devicetree/ |
133 | - directory with info on device tree files used by OF/PowerPC/ARM | |
134 | digsig.txt | |
135 | -info on the Digital Signature Verification API | |
136 | dma-buf-sharing.txt | |
137 | - the DMA Buffer Sharing API Guide | |
f6b07d39 JJ |
138 | dontdiff |
139 | - file containing a list of files that should never be diff'ed. | |
822d289f MCC |
140 | driver-api/ |
141 | - the Linux driver implementer's API guide. | |
1da177e4 LT |
142 | driver-model/ |
143 | - directory with info about Linux driver model. | |
1da177e4 LT |
144 | early-userspace/ |
145 | - info about initramfs, klibc, and userspace early during boot. | |
4a6b88ca AB |
146 | edac.txt |
147 | - information on EDAC - Error Detection And Correction | |
3cf8ca1c HA |
148 | efi-stub.txt |
149 | - How to use the EFI boot stub to bypass GRUB or elilo on EFI systems. | |
1da177e4 LT |
150 | eisa.txt |
151 | - info on EISA bus support. | |
449e3a72 PG |
152 | extcon/ |
153 | - directory with porting guide for Android kernel switch driver. | |
822d289f MCC |
154 | isa.txt |
155 | - info on EISA bus support. | |
f6b07d39 JJ |
156 | fault-injection/ |
157 | - dir with docs about the fault injection capabilities infrastructure. | |
1da177e4 LT |
158 | fb/ |
159 | - directory with info on the frame buffer graphics abstraction layer. | |
822d289f MCC |
160 | features/ |
161 | - status of feature implementation on different architectures. | |
1da177e4 | 162 | filesystems/ |
4f3b19ca | 163 | - info on the vfs and the various filesystems that Linux supports. |
1da177e4 LT |
164 | firmware_class/ |
165 | - request_firmware() hotplug interface info. | |
449e3a72 PG |
166 | flexible-arrays.txt |
167 | - how to make use of flexible sized arrays in linux | |
022c6747 AR |
168 | fmc/ |
169 | - information about the FMC bus abstraction | |
822d289f MCC |
170 | fpga/ |
171 | - FPGA Manager Core. | |
0868ff7a | 172 | frv/ |
f6b07d39 | 173 | - Fujitsu FR-V Linux documentation. |
449e3a72 PG |
174 | futex-requeue-pi.txt |
175 | - info on requeueing of tasks from a non-PI futex to a PI futex | |
822d289f MCC |
176 | gcc-plugins.txt |
177 | - GCC plugin infrastructure. | |
3cf8ca1c HA |
178 | gpio/ |
179 | - gpio related documentation | |
822d289f MCC |
180 | gpu/ |
181 | - directory with information on GPU driver developer's guide. | |
449e3a72 PG |
182 | hid/ |
183 | - directory with information on human interface devices | |
1da177e4 LT |
184 | highuid.txt |
185 | - notes on the change from 16 bit to 32 bit user/group IDs. | |
449e3a72 PG |
186 | hwspinlock.txt |
187 | - hardware spinlock provides hardware assistance for synchronization | |
3833eecc TG |
188 | timers/ |
189 | - info on the timer related topics | |
1da177e4 LT |
190 | hw_random.txt |
191 | - info on Linux support for random number generator in i8xx chipsets. | |
f6b07d39 JJ |
192 | hwmon/ |
193 | - directory with docs on various hardware monitoring drivers. | |
1da177e4 LT |
194 | i2c/ |
195 | - directory with info about the I2C bus/protocol (2 wire, kHz speed). | |
71cced6e | 196 | x86/i386/ |
1da177e4 LT |
197 | - directory with info about Linux on Intel 32 bit architecture. |
198 | ia64/ | |
199 | - directory with info about Linux on Intel 64 bit architecture. | |
822d289f MCC |
200 | ide/ |
201 | - Information regarding the Enhanced IDE drive. | |
202 | iio/ | |
203 | - info on industrial IIO configfs support. | |
f6b07d39 JJ |
204 | infiniband/ |
205 | - directory with documents concerning Linux InfiniBand support. | |
1da177e4 LT |
206 | input/ |
207 | - info on Linux input device support. | |
449e3a72 PG |
208 | intel_txt.txt |
209 | - info on intel Trusted Execution Technology (intel TXT). | |
9fe41e41 RD |
210 | io-mapping.txt |
211 | - description of io_mapping functions in linux/io-mapping.h | |
1da177e4 LT |
212 | io_ordering.txt |
213 | - info on ordering I/O writes to memory-mapped addresses. | |
f6b07d39 JJ |
214 | ioctl/ |
215 | - directory with documents describing various IOCTL calls. | |
1da177e4 LT |
216 | iostats.txt |
217 | - info on I/O statistics Linux kernel provides. | |
f6b07d39 JJ |
218 | irqflags-tracing.txt |
219 | - how to use the irq-flags tracing feature. | |
1da177e4 LT |
220 | isapnp.txt |
221 | - info on Linux ISA Plug & Play support. | |
222 | isdn/ | |
223 | - directory with info on the Linux ISDN support, and supported cards. | |
1da177e4 LT |
224 | kbuild/ |
225 | - directory with info about the kernel build process. | |
822d289f MCC |
226 | kernel-doc-nano-HOWTO.txt |
227 | - outdated info about kernel-doc documentation. | |
f6b07d39 JJ |
228 | kdump/ |
229 | - directory with mini HowTo on getting the crash dump code to work. | |
1dc4bbf0 | 230 | doc-guide/ |
8ed292fe | 231 | - how to write and format reStructuredText kernel documentation |
3cf8ca1c HA |
232 | kernel-per-CPU-kthreads.txt |
233 | - List of all per-CPU kthreads and how they introduce jitter. | |
1da177e4 LT |
234 | kobject.txt |
235 | - info of the kobject infrastructure of the Linux kernel. | |
f6b07d39 JJ |
236 | kprobes.txt |
237 | - documents the kernel probes debugging feature. | |
238 | kref.txt | |
239 | - docs on adding reference counters (krefs) to kernel objects. | |
8ea8f3eb HA |
240 | kselftest.txt |
241 | - small unittests for (some) individual codepaths in the kernel. | |
d6ff3655 CC |
242 | laptops/ |
243 | - directory with laptop related info and laptop driver documentation. | |
1da177e4 LT |
244 | ldm.txt |
245 | - a brief description of LDM (Windows Dynamic Disks). | |
9a684e19 AO |
246 | leds/ |
247 | - directory with info about LED handling under Linux. | |
822d289f MCC |
248 | livepatch/ |
249 | - info on kernel live patching. | |
214e0aed DB |
250 | locking/ |
251 | - directory with info about kernel locking primitives | |
fd058733 JD |
252 | lockup-watchdogs.txt |
253 | - info on soft and hard lockup detectors (aka nmi_watchdog). | |
1da177e4 | 254 | logo.gif |
f6b07d39 | 255 | - full colour GIF image of Linux logo (penguin - Tux). |
1da177e4 | 256 | logo.txt |
f6b07d39 | 257 | - info on creator of above logo & site to get additional images from. |
8ea8f3eb HA |
258 | lzo.txt |
259 | - kernel LZO decompressor input formats | |
1da177e4 LT |
260 | m68k/ |
261 | - directory with info about Linux on Motorola 68k architecture. | |
8ea8f3eb HA |
262 | mailbox.txt |
263 | - How to write drivers for the common mailbox framework (IPC). | |
822d289f MCC |
264 | md-cluster.txt |
265 | - info on shared-device RAID MD cluster. | |
266 | media/ | |
267 | - info on media drivers: uAPI, kAPI and driver documentation. | |
f6b07d39 JJ |
268 | memory-barriers.txt |
269 | - info on Linux kernel memory barriers. | |
449e3a72 PG |
270 | memory-devices/ |
271 | - directory with info on parts like the Texas Instruments EMIF driver | |
5ef43567 RL |
272 | memory-hotplug.txt |
273 | - Hotpluggable memory support, how to use and current status. | |
822d289f MCC |
274 | men-chameleon-bus.txt |
275 | - info on MEN chameleon bus. | |
fdabf525 JH |
276 | metag/ |
277 | - directory with info about Linux on Meta architecture. | |
822d289f MCC |
278 | mic/ |
279 | - Intel Many Integrated Core (MIC) architecture device driver. | |
1da177e4 LT |
280 | mips/ |
281 | - directory with info about Linux on MIPS architecture. | |
449e3a72 PG |
282 | misc-devices/ |
283 | - directory with info about devices using the misc dev subsystem | |
dfe86cba AH |
284 | mmc/ |
285 | - directory with info about the MMC subsystem | |
449e3a72 PG |
286 | mn10300/ |
287 | - directory with info about the mn10300 architecture port | |
288 | mtd/ | |
289 | - directory with info about memory technology devices (flash) | |
2868f89f PE |
290 | namespaces/ |
291 | - directory with various information about namespaces | |
8802f616 PM |
292 | netlabel/ |
293 | - directory with information on the NetLabel subsystem. | |
1da177e4 LT |
294 | networking/ |
295 | - directory with info on various aspects of networking with Linux. | |
449e3a72 PG |
296 | nfc/ |
297 | - directory relating info about Near Field Communications support. | |
822d289f MCC |
298 | nios2/ |
299 | - Linux on the Nios II architecture. | |
f6b07d39 JJ |
300 | nommu-mmap.txt |
301 | - documentation about no-mmu memory mapping support. | |
1da177e4 LT |
302 | numastat.txt |
303 | - info on how to read Numa policy hit/miss statistics in sysfs. | |
822d289f MCC |
304 | ntb.txt |
305 | - info on Non-Transparent Bridge (NTB) drivers. | |
306 | nvdimm/ | |
307 | - info on non-volatile devices. | |
308 | nvmem/ | |
309 | - info on non volatile memory framework. | |
4047f8b1 JC |
310 | padata.txt |
311 | - An introduction to the "padata" parallel execution API | |
1da177e4 LT |
312 | parisc/ |
313 | - directory with info on using Linux on PA-RISC architecture. | |
1da177e4 LT |
314 | parport-lowlevel.txt |
315 | - description and usage of the low level parallel port functions. | |
f6b07d39 JJ |
316 | pcmcia/ |
317 | - info on the Linux PCMCIA driver. | |
449e3a72 PG |
318 | percpu-rw-semaphore.txt |
319 | - RCU based read-write semaphore optimized for locking for reading | |
822d289f MCC |
320 | perf/ |
321 | - info about the APM X-Gene SoC Performance Monitoring Unit (PMU). | |
322 | phy/ | |
323 | - ino on Samsung USB 2.0 PHY adaptation layer. | |
3cf8ca1c HA |
324 | phy.txt |
325 | - Description of the generic PHY framework. | |
f6b07d39 | 326 | pi-futex.txt |
449e3a72 PG |
327 | - documentation on lightweight priority inheritance futexes. |
328 | pinctrl.txt | |
329 | - info on pinctrl subsystem and the PINMUX/PINCONF and drivers | |
822d289f MCC |
330 | platform/ |
331 | - List of supported hardware by compal and Dell laptop. | |
1da177e4 LT |
332 | pnp.txt |
333 | - Linux Plug and Play documentation. | |
334 | power/ | |
335 | - directory with info on Linux PCI power management. | |
336 | powerpc/ | |
337 | - directory with info on using Linux with the PowerPC. | |
449e3a72 PG |
338 | prctl/ |
339 | - directory with info on the priveledge control subsystem | |
1da177e4 LT |
340 | preempt-locking.txt |
341 | - info on locking under a preemptive kernel. | |
b67ad18b RD |
342 | printk-formats.txt |
343 | - how to get printk format specifiers right | |
79c87c30 MCC |
344 | process/ |
345 | - how to work with the mainline kernel development process. | |
449e3a72 PG |
346 | pps/ |
347 | - directory with information on the pulse-per-second support | |
822d289f MCC |
348 | pti/ |
349 | - directory with info on Intel MID PTI. | |
449e3a72 PG |
350 | ptp/ |
351 | - directory with info on support for IEEE 1588 PTP clocks in Linux. | |
352 | pwm.txt | |
353 | - info on the pulse width modulation driver subsystem | |
449e3a72 PG |
354 | rapidio/ |
355 | - directory with info on RapidIO packet-based fabric interconnect | |
f6b07d39 JJ |
356 | rbtree.txt |
357 | - info on what red-black trees are and what they are for. | |
449e3a72 PG |
358 | remoteproc.txt |
359 | - info on how to handle remote processor (e.g. AMP) offloads/usage. | |
360 | rfkill.txt | |
361 | - info on the radio frequency kill switch subsystem/support. | |
f6b07d39 JJ |
362 | robust-futex-ABI.txt |
363 | - documentation of the robust futex ABI. | |
364 | robust-futexes.txt | |
365 | - a description of what robust futexes are. | |
449e3a72 PG |
366 | rpmsg.txt |
367 | - info on the Remote Processor Messaging (rpmsg) Framework | |
1da177e4 LT |
368 | rtc.txt |
369 | - notes on how to use the Real Time Clock (aka CMOS clock) driver. | |
370 | s390/ | |
371 | - directory with info on using Linux on the IBM S390. | |
9b8eae72 BF |
372 | scheduler/ |
373 | - directory with info on the scheduler. | |
1da177e4 LT |
374 | scsi/ |
375 | - directory with info on Linux scsi support. | |
d410fa4e RD |
376 | security/ |
377 | - directory that contains security-related info | |
1da177e4 LT |
378 | serial/ |
379 | - directory with info on the low level serial API. | |
f6b07d39 JJ |
380 | sgi-ioc4.txt |
381 | - description of the SGI IOC4 PCI (multi function) device. | |
1da177e4 LT |
382 | sh/ |
383 | - directory with info on porting Linux to a new architecture. | |
449e3a72 PG |
384 | smsc_ece1099.txt |
385 | -info on the smsc Keyboard Scan Expansion/GPIO Expansion device. | |
1da177e4 LT |
386 | sound/ |
387 | - directory with info on sound card support. | |
f6b07d39 JJ |
388 | spi/ |
389 | - overview of Linux kernel Serial Peripheral Interface (SPI) support. | |
449e3a72 PG |
390 | static-keys.txt |
391 | - info on how static keys allow debug code in hotpaths via patching | |
1da177e4 LT |
392 | svga.txt |
393 | - short guide on selecting video modes at boot via VGA BIOS. | |
822d289f MCC |
394 | sync_file.txt |
395 | - Sync file API guide. | |
1da177e4 LT |
396 | sysctl/ |
397 | - directory with info on the /proc/sys/* files. | |
449e3a72 PG |
398 | target/ |
399 | - directory with info on generating TCM v4 fabric .ko modules | |
3cf8ca1c HA |
400 | this_cpu_ops.txt |
401 | - List rationale behind and the way to use this_cpu operations. | |
449e3a72 PG |
402 | thermal/ |
403 | - directory with information on managing thermal issues (CPU/temp) | |
404 | trace/ | |
405 | - directory with info on tracing technologies within linux | |
822d289f MCC |
406 | translations/ |
407 | - translations of this document from English to another language | |
449e3a72 PG |
408 | unaligned-memory-access.txt |
409 | - info on how to avoid arch breaking unaligned memory access in code. | |
f6b07d39 JJ |
410 | unshare.txt |
411 | - description of the Linux unshare system call. | |
1da177e4 LT |
412 | usb/ |
413 | - directory with info regarding the Universal Serial Bus. | |
449e3a72 PG |
414 | vfio.txt |
415 | - info on Virtual Function I/O used in guest/hypervisor instances. | |
f6b07d39 JJ |
416 | video-output.txt |
417 | - sysfs class driver interface to enable/disable a video output device. | |
449e3a72 PG |
418 | virtual/ |
419 | - directory with information on the various linux virtualizations. | |
1da177e4 LT |
420 | vm/ |
421 | - directory with info on the Linux vm code. | |
f6b07d39 JJ |
422 | w1/ |
423 | - directory with documents regarding the 1-wire (w1) subsystem. | |
1da177e4 LT |
424 | watchdog/ |
425 | - how to auto-reboot Linux if it has "fallen and can't get up". ;-) | |
449e3a72 PG |
426 | wimax/ |
427 | - directory with info about Intel Wireless Wimax Connections | |
24755a55 | 428 | core-api/workqueue.rst |
449e3a72 | 429 | - information on the Concurrency Managed Workqueue implementation |
71cced6e | 430 | x86/x86_64/ |
1da177e4 | 431 | - directory with info on Linux support for AMD x86-64 (Hammer) machines. |
8ea8f3eb HA |
432 | xillybus.txt |
433 | - Overview and basic ui of xillybus driver | |
449e3a72 PG |
434 | xtensa/ |
435 | - directory with documents relating to arch/xtensa port/implementation | |
436 | xz.txt | |
437 | - how to make use of the XZ data compression within linux kernel | |
1da177e4 LT |
438 | zorro.txt |
439 | - info on writing drivers for Zorro bus devices found on Amigas. |