2
2
This is a brief list of all the files in ./linux/Documentation and what
3
3
they contain. If you add a documentation file, please list it here in
4
4
alphabetical order as well, or risk being hunted down like a rabid dog.
5
- Please try and keep the descriptions small enough to fit on one line.
5
+ Please keep the descriptions small enough to fit on one line.
6
6
Thanks -- Paul G.
7
7
8
8
Following translations are available on the WWW:
@@ -20,24 +20,33 @@ BUG-HUNTING
20
20
Changes
21
21
- list of changes that break older software packages.
22
22
CodingStyle
23
- - how the boss likes the C code in the kernel to look.
24
- development-process/
25
- - An extended tutorial on how to work with the kernel development
26
- process.
23
+ - how the maintainers expect the C code in the kernel to look.
27
24
DMA-API.txt
28
25
- DMA API, pci_ API & extensions for non-consistent memory machines.
26
+ DMA-API-HOWTO.txt
27
+ - Dynamic DMA mapping Guide
29
28
DMA-ISA-LPC.txt
30
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
31
32
DocBook/
32
33
- directory with DocBook templates etc. for kernel documentation.
34
+ EDID/
35
+ - directory with info on customizing EDID for broken gfx/displays.
33
36
HOWTO
34
37
- the process and procedures of how to do Linux kernel development.
35
38
IPMI.txt
36
39
- info on Linux Intelligent Platform Management Interface (IPMI) Driver.
37
40
IRQ-affinity.txt
38
41
- how to select which CPU(s) handle which interrupt events on SMP.
42
+ IRQ-domain.txt
43
+ - info on inerrupt numbering and setting up IRQ domains.
39
44
IRQ.txt
40
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
41
50
ManagementStyle
42
51
- how to (attempt to) manage kernel hackers.
43
52
RCU/
@@ -66,10 +75,16 @@ applying-patches.txt
66
75
- description of various trees and how to apply their patches.
67
76
arm/
68
77
- directory with info about Linux on the ARM architecture.
78
+ arm64/
79
+ - directory with info about Linux on the 64 bit ARM architecture.
69
80
atomic_ops.txt
70
81
- semantics and behavior of atomic and bitmask operations.
71
82
auxdisplay/
72
83
- misc. LCD driver documentation (cfag12864b, ks0108).
84
+ backlight/
85
+ - directory with info on controlling backlights in flat panel displays
86
+ bad_memory.txt
87
+ - how to use kernel parameters to exclude bad RAM regions.
73
88
basic_profiling.txt
74
89
- basic instructions for those who wants to profile Linux kernel.
75
90
binfmt_misc.txt
@@ -80,8 +95,14 @@ block/
80
95
- info on the Block I/O (BIO) layer.
81
96
blockdev/
82
97
- info on block devices & drivers
98
+ braille-console.txt
99
+ - info on how to use serial devices for Braille support.
100
+ bt8xxgpio.txt
101
+ - info on how to modify a bt8xx video card for GPIO usage.
83
102
btmrvl.txt
84
103
- info on Marvell Bluetooth driver usage.
104
+ bus-devices/
105
+ - directory with info on TI GPMC (General Purpose Memory Controller)
85
106
bus-virt-phys-mapping.txt
86
107
- how to access I/O mapped memory from within device drivers.
87
108
cachetlb.txt
@@ -90,6 +111,12 @@ cdrom/
90
111
- directory with information on the CD-ROM drivers that Linux has.
91
112
cgroups/
92
113
- cgroups features, including cpusets and memory controller.
114
+ circular-buffers.txt
115
+ - how to make use of the existing circular buffer infrastructure
116
+ clk.txt
117
+ - info on the common clock framework
118
+ coccinelle.txt
119
+ - info on how to get and use the Coccinelle code checking tool.
93
120
connector/
94
121
- docs on the netlink based userspace<->kernel space communication mod.
95
122
console/
@@ -114,24 +141,42 @@ dcdbas.txt
114
141
- information on the Dell Systems Management Base Driver.
115
142
debugging-modules.txt
116
143
- some notes on debugging modules after Linux 2.6.3.
144
+ debugging-via-ohci1394.txt
145
+ - how to use firewire like a hardware debugger memory reader.
117
146
dell_rbu.txt
118
147
- document demonstrating the use of the Dell Remote BIOS Update driver.
148
+ development-process/
149
+ - how to work with the mainline kernel development process.
119
150
device-mapper/
120
151
- directory with info on Device Mapper.
121
152
devices.txt
122
153
- plain ASCII listing of all the nodes in /dev/ with major minor #'s.
154
+ devicetree/
155
+ - directory with info on device tree files used by OF/PowerPC/ARM
156
+ digsig.txt
157
+ -info on the Digital Signature Verification API
158
+ dma-buf-sharing.txt
159
+ - the DMA Buffer Sharing API Guide
160
+ dmaengine.txt
161
+ -the DMA Engine API Guide
123
162
dontdiff
124
163
- file containing a list of files that should never be diff'ed.
125
164
driver-model/
126
165
- directory with info about Linux driver model.
127
166
dvb/
128
167
- info on Linux Digital Video Broadcast (DVB) subsystem.
168
+ dynamic-debug-howto.txt
169
+ - how to use the dynamic debug (dyndbg) feature.
129
170
early-userspace/
130
171
- info about initramfs, klibc, and userspace early during boot.
131
172
edac.txt
132
173
- information on EDAC - Error Detection And Correction
133
174
eisa.txt
134
175
- info on EISA bus support.
176
+ email-clients.txt
177
+ - info on how to use e-mail to send un-mangled (git) patches.
178
+ extcon/
179
+ - directory with porting guide for Android kernel switch driver.
135
180
fault-injection/
136
181
- dir with docs about the fault injection capabilities infrastructure.
137
182
fb/
@@ -140,12 +185,22 @@ filesystems/
140
185
- info on the vfs and the various filesystems that Linux supports.
141
186
firmware_class/
142
187
- request_firmware() hotplug interface info.
188
+ flexible-arrays.txt
189
+ - how to make use of flexible sized arrays in linux
143
190
frv/
144
191
- Fujitsu FR-V Linux documentation.
192
+ futex-requeue-pi.txt
193
+ - info on requeueing of tasks from a non-PI futex to a PI futex
194
+ gcov.txt
195
+ - use of GCC's coverage testing tool "gcov" with the Linux kernel
145
196
gpio.txt
146
197
- overview of GPIO (General Purpose Input/Output) access conventions.
198
+ hid/
199
+ - directory with information on human interface devices
147
200
highuid.txt
148
201
- notes on the change from 16 bit to 32 bit user/group IDs.
202
+ hwspinlock.txt
203
+ - hardware spinlock provides hardware assistance for synchronization
149
204
timers/
150
205
- info on the timer related topics
151
206
hw_random.txt
@@ -162,10 +217,14 @@ ia64/
162
217
- directory with info about Linux on Intel 64 bit architecture.
163
218
infiniband/
164
219
- directory with documents concerning Linux InfiniBand support.
220
+ init.txt
221
+ - what to do when the kernel can't find the 1st process to run.
165
222
initrd.txt
166
223
- how to use the RAM disk as an initial/temporary root filesystem.
167
224
input/
168
225
- info on Linux input device support.
226
+ intel_txt.txt
227
+ - info on intel Trusted Execution Technology (intel TXT).
169
228
io-mapping.txt
170
229
- description of io_mapping functions in linux/io-mapping.h
171
230
io_ordering.txt
@@ -182,6 +241,8 @@ isdn/
182
241
- directory with info on the Linux ISDN support, and supported cards.
183
242
java.txt
184
243
- info on the in-kernel binary support for Java(tm).
244
+ ja_JP/
245
+ - directory with Japanese translations of various documents
185
246
kbuild/
186
247
- directory with info about the kernel build process.
187
248
kdump/
@@ -192,6 +253,12 @@ kernel-docs.txt
192
253
- listing of various WWW + books that document kernel internals.
193
254
kernel-parameters.txt
194
255
- summary listing of command line / boot prompt args for the kernel.
256
+ kmemcheck.txt
257
+ - info on dynamic checker that detects uses of uninitialized memory.
258
+ kmemleak.txt
259
+ - info on how to make use of the kernel memory leak detection system
260
+ ko_KR/
261
+ - directory with Korean translations of various documents
195
262
kobject.txt
196
263
- info of the kobject infrastructure of the Linux kernel.
197
264
kprobes.txt
@@ -208,6 +275,8 @@ local_ops.txt
208
275
- semantics and behavior of local atomic operations.
209
276
lockdep-design.txt
210
277
- documentation on the runtime locking correctness validator.
278
+ lockstat.txt
279
+ - info on collecting statistics on locks (and contention).
211
280
lockup-watchdogs.txt
212
281
- info on soft and hard lockup detectors (aka nmi_watchdog).
213
282
logo.gif
@@ -220,16 +289,26 @@ magic-number.txt
220
289
- list of magic numbers used to mark/protect kernel data structures.
221
290
md.txt
222
291
- info on boot arguments for the multiple devices driver.
292
+ media-framework.txt
293
+ - info on media framework, its data structures, functions and usage.
223
294
memory-barriers.txt
224
295
- info on Linux kernel memory barriers.
296
+ memory-devices/
297
+ - directory with info on parts like the Texas Instruments EMIF driver
225
298
memory-hotplug.txt
226
299
- Hotpluggable memory support, how to use and current status.
227
300
memory.txt
228
301
- info on typical Linux memory problems.
229
302
mips/
230
303
- directory with info about Linux on MIPS architecture.
304
+ misc-devices/
305
+ - directory with info about devices using the misc dev subsystem
231
306
mmc/
232
307
- directory with info about the MMC subsystem
308
+ mn10300/
309
+ - directory with info about the mn10300 architecture port
310
+ mtd/
311
+ - directory with info about memory technology devices (flash)
233
312
mono.txt
234
313
- how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
235
314
mutex-design.txt
@@ -240,6 +319,8 @@ netlabel/
240
319
- directory with information on the NetLabel subsystem.
241
320
networking/
242
321
- directory with info on various aspects of networking with Linux.
322
+ nfc/
323
+ - directory relating info about Near Field Communications support.
243
324
nommu-mmap.txt
244
325
- documentation about no-mmu memory mapping support.
245
326
numastat.txt
@@ -256,26 +337,46 @@ parport-lowlevel.txt
256
337
- description and usage of the low level parallel port functions.
257
338
pcmcia/
258
339
- info on the Linux PCMCIA driver.
340
+ percpu-rw-semaphore.txt
341
+ - RCU based read-write semaphore optimized for locking for reading
259
342
pi-futex.txt
260
- - documentation on lightweight PI-futexes.
343
+ - documentation on lightweight priority inheritance futexes.
344
+ pinctrl.txt
345
+ - info on pinctrl subsystem and the PINMUX/PINCONF and drivers
261
346
pnp.txt
262
347
- Linux Plug and Play documentation.
263
348
power/
264
349
- directory with info on Linux PCI power management.
265
350
powerpc/
266
351
- directory with info on using Linux with the PowerPC.
352
+ prctl/
353
+ - directory with info on the priveledge control subsystem
267
354
preempt-locking.txt
268
355
- info on locking under a preemptive kernel.
269
356
printk-formats.txt
270
357
- how to get printk format specifiers right
358
+ pps/
359
+ - directory with information on the pulse-per-second support
360
+ ptp/
361
+ - directory with info on support for IEEE 1588 PTP clocks in Linux.
362
+ pwm.txt
363
+ - info on the pulse width modulation driver subsystem
271
364
ramoops.txt
272
365
- documentation of the ramoops oops/panic logging module.
366
+ rapidio/
367
+ - directory with info on RapidIO packet-based fabric interconnect
273
368
rbtree.txt
274
369
- info on what red-black trees are and what they are for.
370
+ remoteproc.txt
371
+ - info on how to handle remote processor (e.g. AMP) offloads/usage.
372
+ rfkill.txt
373
+ - info on the radio frequency kill switch subsystem/support.
275
374
robust-futex-ABI.txt
276
375
- documentation of the robust futex ABI.
277
376
robust-futexes.txt
278
377
- a description of what robust futexes are.
378
+ rpmsg.txt
379
+ - info on the Remote Processor Messaging (rpmsg) Framework
279
380
rt-mutex-design.txt
280
381
- description of the RealTime mutex implementation design.
281
382
rt-mutex.txt
@@ -300,10 +401,10 @@ sgi-visws.txt
300
401
- short blurb on the SGI Visual Workstations.
301
402
sh/
302
403
- directory with info on porting Linux to a new architecture.
404
+ smsc_ece1099.txt
405
+ -info on the smsc Keyboard Scan Expansion/GPIO Expansion device.
303
406
sound/
304
407
- directory with info on sound card support.
305
- sparc/
306
- - directory with info on using Linux on Sparc architecture.
307
408
sparse.txt
308
409
- info on how to obtain and use the sparse tool for typechecking.
309
410
spi/
@@ -314,6 +415,8 @@ stable_api_nonsense.txt
314
415
- info on why the kernel does not have a stable in-kernel api or abi.
315
416
stable_kernel_rules.txt
316
417
- rules and procedures for the -stable kernel releases.
418
+ static-keys.txt
419
+ - info on how static keys allow debug code in hotpaths via patching
317
420
svga.txt
318
421
- short guide on selecting video modes at boot via VGA BIOS.
319
422
sysfs-rules.txt
@@ -322,27 +425,53 @@ sysctl/
322
425
- directory with info on the /proc/sys/* files.
323
426
sysrq.txt
324
427
- info on the magic SysRq key.
325
- telephony/
326
- - directory with info on telephony (e.g. voice over IP) support.
428
+ target/
429
+ - directory with info on generating TCM v4 fabric .ko modules
430
+ thermal/
431
+ - directory with information on managing thermal issues (CPU/temp)
432
+ trace/
433
+ - directory with info on tracing technologies within linux
434
+ unaligned-memory-access.txt
435
+ - info on how to avoid arch breaking unaligned memory access in code.
327
436
unicode.txt
328
437
- info on the Unicode character/font mapping used in Linux.
329
438
unshare.txt
330
439
- description of the Linux unshare system call.
331
440
usb/
332
441
- directory with info regarding the Universal Serial Bus.
442
+ vDSO/
443
+ - directory with info regarding virtual dynamic shared objects
444
+ vfio.txt
445
+ - info on Virtual Function I/O used in guest/hypervisor instances.
446
+ vgaarbiter.txt
447
+ - info on enable/disable the legacy decoding on different VGA devices
333
448
video-output.txt
334
449
- sysfs class driver interface to enable/disable a video output device.
335
450
video4linux/
336
451
- directory with info regarding video/TV/radio cards and linux.
452
+ virtual/
453
+ - directory with information on the various linux virtualizations.
337
454
vm/
338
455
- directory with info on the Linux vm code.
456
+ vme_api.txt
457
+ - file relating info on the VME bus API in linux
339
458
volatile-considered-harmful.txt
340
459
- Why the "volatile" type class should not be used
341
460
w1/
342
461
- directory with documents regarding the 1-wire (w1) subsystem.
343
462
watchdog/
344
463
- how to auto-reboot Linux if it has "fallen and can't get up". ;-)
464
+ wimax/
465
+ - directory with info about Intel Wireless Wimax Connections
466
+ workqueue.txt
467
+ - information on the Concurrency Managed Workqueue implementation
345
468
x86/x86_64/
346
469
- directory with info on Linux support for AMD x86-64 (Hammer) machines.
470
+ xtensa/
471
+ - directory with documents relating to arch/xtensa port/implementation
472
+ xz.txt
473
+ - how to make use of the XZ data compression within linux kernel
474
+ zh_CN/
475
+ - directory with Chinese translations of various documents
347
476
zorro.txt
348
477
- info on writing drivers for Zorro bus devices found on Amigas.
0 commit comments