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