Root/Documentation/00-INDEX

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.
17
18BUG-HUNTING
19    - brute force method of doing binary search of patches to find bug.
20Changes
21    - list of changes that break older software packages.
22CodingStyle
23    - how the maintainers expect the C code in the kernel to look.
24DMA-API.txt
25    - DMA API, pci_ API & extensions for non-consistent memory machines.
26DMA-API-HOWTO.txt
27    - Dynamic DMA mapping Guide
28DMA-ISA-LPC.txt
29    - How to do DMA with ISA (and LPC) devices.
30DMA-attributes.txt
31    - listing of the various possible attributes a DMA region can have
32DocBook/
33    - directory with DocBook templates etc. for kernel documentation.
34EDID/
35    - directory with info on customizing EDID for broken gfx/displays.
36HOWTO
37    - the process and procedures of how to do Linux kernel development.
38IPMI.txt
39    - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
40IRQ-affinity.txt
41    - how to select which CPU(s) handle which interrupt events on SMP.
42IRQ-domain.txt
43    - info on inerrupt numbering and setting up IRQ domains.
44IRQ.txt
45    - description of what an IRQ is.
46Intel-IOMMU.txt
47    - basic info on the Intel IOMMU virtualization support.
48Makefile
49    - some files in Documentation dir are actually sample code to build
50ManagementStyle
51    - how to (attempt to) manage kernel hackers.
52RCU/
53    - directory with info on RCU (read-copy update).
54SAK.txt
55    - info on Secure Attention Keys.
56SM501.txt
57    - Silicon Motion SM501 multimedia companion chip
58SecurityBugs
59    - procedure for reporting security bugs found in the kernel.
60SubmitChecklist
61    - Linux kernel patch submission checklist.
62SubmittingDrivers
63    - procedure to get a new driver source included into the kernel tree.
64SubmittingPatches
65    - procedure to get a source patch included into the kernel tree.
66VGA-softcursor.txt
67    - how to change your VGA cursor from a blinking underscore.
68accounting/
69    - documentation on accounting and taskstats.
70acpi/
71    - info on ACPI-specific hooks in the kernel.
72aoe/
73    - description of AoE (ATA over Ethernet) along with config examples.
74applying-patches.txt
75    - description of various trees and how to apply their patches.
76arm/
77    - directory with info about Linux on the ARM architecture.
78arm64/
79    - directory with info about Linux on the 64 bit ARM architecture.
80atomic_ops.txt
81    - semantics and behavior of atomic and bitmask operations.
82auxdisplay/
83    - misc. LCD driver documentation (cfag12864b, ks0108).
84backlight/
85    - directory with info on controlling backlights in flat panel displays
86bad_memory.txt
87    - how to use kernel parameters to exclude bad RAM regions.
88basic_profiling.txt
89    - basic instructions for those who wants to profile Linux kernel.
90binfmt_misc.txt
91    - info on the kernel support for extra binary formats.
92blackfin/
93    - directory with documentation for the Blackfin arch.
94block/
95    - info on the Block I/O (BIO) layer.
96blockdev/
97    - info on block devices & drivers
98braille-console.txt
99    - info on how to use serial devices for Braille support.
100bt8xxgpio.txt
101    - info on how to modify a bt8xx video card for GPIO usage.
102btmrvl.txt
103    - info on Marvell Bluetooth driver usage.
104bus-devices/
105    - directory with info on TI GPMC (General Purpose Memory Controller)
106bus-virt-phys-mapping.txt
107    - how to access I/O mapped memory from within device drivers.
108cachetlb.txt
109    - describes the cache/TLB flushing interfaces Linux uses.
110cdrom/
111    - directory with information on the CD-ROM drivers that Linux has.
112cgroups/
113    - cgroups features, including cpusets and memory controller.
114circular-buffers.txt
115    - how to make use of the existing circular buffer infrastructure
116clk.txt
117    - info on the common clock framework
118coccinelle.txt
119    - info on how to get and use the Coccinelle code checking tool.
120connector/
121    - docs on the netlink based userspace<->kernel space communication mod.
122console/
123    - documentation on Linux console drivers.
124cpu-freq/
125    - info on CPU frequency and voltage scaling.
126cpu-hotplug.txt
127    - document describing CPU hotplug support in the Linux kernel.
128cpu-load.txt
129    - document describing how CPU load statistics are collected.
130cpuidle/
131    - info on CPU_IDLE, CPU idle state management subsystem.
132cputopology.txt
133    - documentation on how CPU topology info is exported via sysfs.
134crc32.txt
135    - brief tutorial on CRC computation
136cris/
137    - directory with info about Linux on CRIS architecture.
138crypto/
139    - directory with info on the Crypto API.
140dcdbas.txt
141    - information on the Dell Systems Management Base Driver.
142debugging-modules.txt
143    - some notes on debugging modules after Linux 2.6.3.
144debugging-via-ohci1394.txt
145    - how to use firewire like a hardware debugger memory reader.
146dell_rbu.txt
147    - document demonstrating the use of the Dell Remote BIOS Update driver.
148development-process/
149    - how to work with the mainline kernel development process.
150device-mapper/
151    - directory with info on Device Mapper.
152devices.txt
153    - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
154devicetree/
155    - directory with info on device tree files used by OF/PowerPC/ARM
156digsig.txt
157    -info on the Digital Signature Verification API
158dma-buf-sharing.txt
159    - the DMA Buffer Sharing API Guide
160dmaengine.txt
161    -the DMA Engine API Guide
162dontdiff
163    - file containing a list of files that should never be diff'ed.
164driver-model/
165    - directory with info about Linux driver model.
166dvb/
167    - info on Linux Digital Video Broadcast (DVB) subsystem.
168dynamic-debug-howto.txt
169    - how to use the dynamic debug (dyndbg) feature.
170early-userspace/
171    - info about initramfs, klibc, and userspace early during boot.
172edac.txt
173    - information on EDAC - Error Detection And Correction
174eisa.txt
175    - info on EISA bus support.
176email-clients.txt
177    - info on how to use e-mail to send un-mangled (git) patches.
178extcon/
179    - directory with porting guide for Android kernel switch driver.
180fault-injection/
181    - dir with docs about the fault injection capabilities infrastructure.
182fb/
183    - directory with info on the frame buffer graphics abstraction layer.
184filesystems/
185    - info on the vfs and the various filesystems that Linux supports.
186firmware_class/
187    - request_firmware() hotplug interface info.
188flexible-arrays.txt
189    - how to make use of flexible sized arrays in linux
190frv/
191    - Fujitsu FR-V Linux documentation.
192futex-requeue-pi.txt
193    - info on requeueing of tasks from a non-PI futex to a PI futex
194gcov.txt
195    - use of GCC's coverage testing tool "gcov" with the Linux kernel
196gpio.txt
197    - overview of GPIO (General Purpose Input/Output) access conventions.
198hid/
199    - directory with information on human interface devices
200highuid.txt
201    - notes on the change from 16 bit to 32 bit user/group IDs.
202hwspinlock.txt
203    - hardware spinlock provides hardware assistance for synchronization
204timers/
205    - info on the timer related topics
206hw_random.txt
207    - info on Linux support for random number generator in i8xx chipsets.
208hwmon/
209    - directory with docs on various hardware monitoring drivers.
210i2c/
211    - directory with info about the I2C bus/protocol (2 wire, kHz speed).
212i2o/
213    - directory with info about the Linux I2O subsystem.
214x86/i386/
215    - directory with info about Linux on Intel 32 bit architecture.
216ia64/
217    - directory with info about Linux on Intel 64 bit architecture.
218infiniband/
219    - directory with documents concerning Linux InfiniBand support.
220init.txt
221    - what to do when the kernel can't find the 1st process to run.
222initrd.txt
223    - how to use the RAM disk as an initial/temporary root filesystem.
224input/
225    - info on Linux input device support.
226intel_txt.txt
227    - info on intel Trusted Execution Technology (intel TXT).
228io-mapping.txt
229    - description of io_mapping functions in linux/io-mapping.h
230io_ordering.txt
231    - info on ordering I/O writes to memory-mapped addresses.
232ioctl/
233    - directory with documents describing various IOCTL calls.
234iostats.txt
235    - info on I/O statistics Linux kernel provides.
236irqflags-tracing.txt
237    - how to use the irq-flags tracing feature.
238isapnp.txt
239    - info on Linux ISA Plug & Play support.
240isdn/
241    - directory with info on the Linux ISDN support, and supported cards.
242java.txt
243    - info on the in-kernel binary support for Java(tm).
244ja_JP/
245    - directory with Japanese translations of various documents
246kbuild/
247    - directory with info about the kernel build process.
248kdump/
249    - directory with mini HowTo on getting the crash dump code to work.
250kernel-doc-nano-HOWTO.txt
251    - mini HowTo on generation and location of kernel documentation files.
252kernel-docs.txt
253    - listing of various WWW + books that document kernel internals.
254kernel-parameters.txt
255    - summary listing of command line / boot prompt args for the kernel.
256kmemcheck.txt
257    - info on dynamic checker that detects uses of uninitialized memory.
258kmemleak.txt
259    - info on how to make use of the kernel memory leak detection system
260ko_KR/
261    - directory with Korean translations of various documents
262kobject.txt
263    - info of the kobject infrastructure of the Linux kernel.
264kprobes.txt
265    - documents the kernel probes debugging feature.
266kref.txt
267    - docs on adding reference counters (krefs) to kernel objects.
268laptops/
269    - directory with laptop related info and laptop driver documentation.
270ldm.txt
271    - a brief description of LDM (Windows Dynamic Disks).
272leds/
273    - directory with info about LED handling under Linux.
274local_ops.txt
275    - semantics and behavior of local atomic operations.
276lockdep-design.txt
277    - documentation on the runtime locking correctness validator.
278lockstat.txt
279    - info on collecting statistics on locks (and contention).
280lockup-watchdogs.txt
281    - info on soft and hard lockup detectors (aka nmi_watchdog).
282logo.gif
283    - full colour GIF image of Linux logo (penguin - Tux).
284logo.txt
285    - info on creator of above logo & site to get additional images from.
286m68k/
287    - directory with info about Linux on Motorola 68k architecture.
288magic-number.txt
289    - list of magic numbers used to mark/protect kernel data structures.
290md.txt
291    - info on boot arguments for the multiple devices driver.
292media-framework.txt
293    - info on media framework, its data structures, functions and usage.
294memory-barriers.txt
295    - info on Linux kernel memory barriers.
296memory-devices/
297    - directory with info on parts like the Texas Instruments EMIF driver
298memory-hotplug.txt
299    - Hotpluggable memory support, how to use and current status.
300memory.txt
301    - info on typical Linux memory problems.
302metag/
303    - directory with info about Linux on Meta architecture.
304mips/
305    - directory with info about Linux on MIPS architecture.
306misc-devices/
307    - directory with info about devices using the misc dev subsystem
308mmc/
309    - directory with info about the MMC subsystem
310mn10300/
311    - directory with info about the mn10300 architecture port
312mtd/
313    - directory with info about memory technology devices (flash)
314mono.txt
315    - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
316mutex-design.txt
317    - info on the generic mutex subsystem.
318namespaces/
319    - directory with various information about namespaces
320netlabel/
321    - directory with information on the NetLabel subsystem.
322networking/
323    - directory with info on various aspects of networking with Linux.
324nfc/
325    - directory relating info about Near Field Communications support.
326nommu-mmap.txt
327    - documentation about no-mmu memory mapping support.
328numastat.txt
329    - info on how to read Numa policy hit/miss statistics in sysfs.
330oops-tracing.txt
331    - how to decode those nasty internal kernel error dump messages.
332padata.txt
333    - An introduction to the "padata" parallel execution API
334parisc/
335    - directory with info on using Linux on PA-RISC architecture.
336parport.txt
337    - how to use the parallel-port driver.
338parport-lowlevel.txt
339    - description and usage of the low level parallel port functions.
340pcmcia/
341    - info on the Linux PCMCIA driver.
342percpu-rw-semaphore.txt
343    - RCU based read-write semaphore optimized for locking for reading
344pi-futex.txt
345    - documentation on lightweight priority inheritance futexes.
346pinctrl.txt
347    - info on pinctrl subsystem and the PINMUX/PINCONF and drivers
348pnp.txt
349    - Linux Plug and Play documentation.
350power/
351    - directory with info on Linux PCI power management.
352powerpc/
353    - directory with info on using Linux with the PowerPC.
354prctl/
355    - directory with info on the priveledge control subsystem
356preempt-locking.txt
357    - info on locking under a preemptive kernel.
358printk-formats.txt
359    - how to get printk format specifiers right
360pps/
361    - directory with information on the pulse-per-second support
362ptp/
363    - directory with info on support for IEEE 1588 PTP clocks in Linux.
364pwm.txt
365    - info on the pulse width modulation driver subsystem
366ramoops.txt
367    - documentation of the ramoops oops/panic logging module.
368rapidio/
369    - directory with info on RapidIO packet-based fabric interconnect
370rbtree.txt
371    - info on what red-black trees are and what they are for.
372remoteproc.txt
373    - info on how to handle remote processor (e.g. AMP) offloads/usage.
374rfkill.txt
375    - info on the radio frequency kill switch subsystem/support.
376robust-futex-ABI.txt
377    - documentation of the robust futex ABI.
378robust-futexes.txt
379    - a description of what robust futexes are.
380rpmsg.txt
381    - info on the Remote Processor Messaging (rpmsg) Framework
382rt-mutex-design.txt
383    - description of the RealTime mutex implementation design.
384rt-mutex.txt
385    - desc. of RT-mutex subsystem with PI (Priority Inheritance) support.
386rtc.txt
387    - notes on how to use the Real Time Clock (aka CMOS clock) driver.
388s390/
389    - directory with info on using Linux on the IBM S390.
390scheduler/
391    - directory with info on the scheduler.
392scsi/
393    - directory with info on Linux scsi support.
394security/
395    - directory that contains security-related info
396serial/
397    - directory with info on the low level serial API.
398serial-console.txt
399    - how to set up Linux with a serial line console as the default.
400sgi-ioc4.txt
401    - description of the SGI IOC4 PCI (multi function) device.
402sgi-visws.txt
403    - short blurb on the SGI Visual Workstations.
404sh/
405    - directory with info on porting Linux to a new architecture.
406smsc_ece1099.txt
407    -info on the smsc Keyboard Scan Expansion/GPIO Expansion device.
408sound/
409    - directory with info on sound card support.
410sparse.txt
411    - info on how to obtain and use the sparse tool for typechecking.
412spi/
413    - overview of Linux kernel Serial Peripheral Interface (SPI) support.
414spinlocks.txt
415    - info on using spinlocks to provide exclusive access in kernel.
416stable_api_nonsense.txt
417    - info on why the kernel does not have a stable in-kernel api or abi.
418stable_kernel_rules.txt
419    - rules and procedures for the -stable kernel releases.
420static-keys.txt
421    - info on how static keys allow debug code in hotpaths via patching
422svga.txt
423    - short guide on selecting video modes at boot via VGA BIOS.
424sysfs-rules.txt
425    - How not to use sysfs.
426sysctl/
427    - directory with info on the /proc/sys/* files.
428sysrq.txt
429    - info on the magic SysRq key.
430target/
431    - directory with info on generating TCM v4 fabric .ko modules
432thermal/
433    - directory with information on managing thermal issues (CPU/temp)
434trace/
435    - directory with info on tracing technologies within linux
436unaligned-memory-access.txt
437    - info on how to avoid arch breaking unaligned memory access in code.
438unicode.txt
439    - info on the Unicode character/font mapping used in Linux.
440unshare.txt
441    - description of the Linux unshare system call.
442usb/
443    - directory with info regarding the Universal Serial Bus.
444vDSO/
445    - directory with info regarding virtual dynamic shared objects
446vfio.txt
447    - info on Virtual Function I/O used in guest/hypervisor instances.
448vgaarbiter.txt
449    - info on enable/disable the legacy decoding on different VGA devices
450video-output.txt
451    - sysfs class driver interface to enable/disable a video output device.
452video4linux/
453    - directory with info regarding video/TV/radio cards and linux.
454virtual/
455    - directory with information on the various linux virtualizations.
456vm/
457    - directory with info on the Linux vm code.
458vme_api.txt
459    - file relating info on the VME bus API in linux
460volatile-considered-harmful.txt
461    - Why the "volatile" type class should not be used
462w1/
463    - directory with documents regarding the 1-wire (w1) subsystem.
464watchdog/
465    - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
466wimax/
467    - directory with info about Intel Wireless Wimax Connections
468workqueue.txt
469    - information on the Concurrency Managed Workqueue implementation
470x86/x86_64/
471    - directory with info on Linux support for AMD x86-64 (Hammer) machines.
472xtensa/
473    - directory with documents relating to arch/xtensa port/implementation
474xz.txt
475    - how to make use of the XZ data compression within linux kernel
476zh_CN/
477    - directory with Chinese translations of various documents
478zorro.txt
479    - info on writing drivers for Zorro bus devices found on Amigas.
480

Archive Download this file



interactive