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