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