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