blob: 0f3e8bbab8d79c5fddfb173f1bb76adf82b008f5 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001
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.
Paul Gortmaker449e3a72013-02-14 15:20:54 -05005Please keep the descriptions small enough to fit on one line.
Linus Torvalds1da177e2005-04-16 15:20:36 -07006 Thanks -- Paul G.
7
8Following translations are available on the WWW:
9
Masanari Iida010f4562012-02-14 23:19:07 +090010 - Japanese, maintained by the JF Project (jf@listserv.linux.or.jp), at
11 http://linuxjf.sourceforge.jp/
Linus Torvalds1da177e2005-04-16 15:20:36 -070012
1300-INDEX
14 - this file.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070015ABI/
16 - info on kernel <-> userspace ABI and relative interface stability.
Len Brownb4d27302007-11-14 19:53:21 -050017
Linus Torvalds1da177e2005-04-16 15:20:36 -070018BUG-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
Paul Gortmaker449e3a72013-02-14 15:20:54 -050023 - how the maintainers expect the C code in the kernel to look.
Linus Torvalds1da177e2005-04-16 15:20:36 -070024DMA-API.txt
25 - DMA API, pci_ API & extensions for non-consistent memory machines.
Paul Gortmaker449e3a72013-02-14 15:20:54 -050026DMA-API-HOWTO.txt
27 - Dynamic DMA mapping Guide
Rob Landley5ef43562007-10-16 23:31:25 -070028DMA-ISA-LPC.txt
29 - How to do DMA with ISA (and LPC) devices.
Paul Gortmaker449e3a72013-02-14 15:20:54 -050030DMA-attributes.txt
31 - listing of the various possible attributes a DMA region can have
Linus Torvalds1da177e2005-04-16 15:20:36 -070032DocBook/
33 - directory with DocBook templates etc. for kernel documentation.
Paul Gortmaker449e3a72013-02-14 15:20:54 -050034EDID/
35 - directory with info on customizing EDID for broken gfx/displays.
Greg Kroah-Hartmand36cc9d2005-11-18 09:31:11 -080036HOWTO
Jesper Juhlf6b07d32007-07-15 23:41:41 -070037 - the process and procedures of how to do Linux kernel development.
Linus Torvalds1da177e2005-04-16 15:20:36 -070038IPMI.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.
Paul Gortmaker449e3a72013-02-14 15:20:54 -050042IRQ-domain.txt
43 - info on inerrupt numbering and setting up IRQ domains.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070044IRQ.txt
45 - description of what an IRQ is.
Paul Gortmaker449e3a72013-02-14 15:20:54 -050046Intel-IOMMU.txt
47 - basic info on the Intel IOMMU virtualization support.
48Makefile
49 - some files in Documentation dir are actually sample code to build
Linus Torvalds1da177e2005-04-16 15:20:36 -070050ManagementStyle
51 - how to (attempt to) manage kernel hackers.
Linus Torvalds1da177e2005-04-16 15:20:36 -070052RCU/
53 - directory with info on RCU (read-copy update).
Linus Torvalds1da177e2005-04-16 15:20:36 -070054SAK.txt
55 - info on Secure Attention Keys.
Rob Landley5ef43562007-10-16 23:31:25 -070056SM501.txt
57 - Silicon Motion SM501 multimedia companion chip
Jesper Juhlf6b07d32007-07-15 23:41:41 -070058SecurityBugs
59 - procedure for reporting security bugs found in the kernel.
60SubmitChecklist
61 - Linux kernel patch submission checklist.
Linus Torvalds1da177e2005-04-16 15:20:36 -070062SubmittingDrivers
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.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070068accounting/
69 - documentation on accounting and taskstats.
Len Brownb4d27302007-11-14 19:53:21 -050070acpi/
71 - info on ACPI-specific hooks in the kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070072aoe/
73 - description of AoE (ATA over Ethernet) along with config examples.
Jesper Juhl754c7972005-09-09 13:10:12 -070074applying-patches.txt
75 - description of various trees and how to apply their patches.
Linus Torvalds1da177e2005-04-16 15:20:36 -070076arm/
77 - directory with info about Linux on the ARM architecture.
Paul Gortmaker449e3a72013-02-14 15:20:54 -050078arm64/
79 - directory with info about Linux on the 64 bit ARM architecture.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070080atomic_ops.txt
81 - semantics and behavior of atomic and bitmask operations.
82auxdisplay/
83 - misc. LCD driver documentation (cfag12864b, ks0108).
Paul Gortmaker449e3a72013-02-14 15:20:54 -050084backlight/
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.
Linus Torvalds1da177e2005-04-16 15:20:36 -070088basic_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.
Jesper Juhlf6b07d32007-07-15 23:41:41 -070092blackfin/
93 - directory with documentation for the Blackfin arch.
Linus Torvalds1da177e2005-04-16 15:20:36 -070094block/
95 - info on the Block I/O (BIO) layer.
Randy Dunlap31c00fc2008-11-13 21:33:24 +000096blockdev/
97 - info on block devices & drivers
Paul Gortmaker449e3a72013-02-14 15:20:54 -050098braille-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.
Bing Zhao196be0c2009-06-02 14:29:38 -0700102btmrvl.txt
103 - info on Marvell Bluetooth driver usage.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500104bus-devices/
105 - directory with info on TI GPMC (General Purpose Memory Controller)
Randy Dunlap9fe41e42010-07-19 22:20:27 +0000106bus-virt-phys-mapping.txt
107 - how to access I/O mapped memory from within device drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108cachetlb.txt
109 - describes the cache/TLB flushing interfaces Linux uses.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110cdrom/
111 - directory with information on the CD-ROM drivers that Linux has.
Thadeu Lima de Souza Cascardo21acb9c2009-02-04 10:12:08 +0100112cgroups/
113 - cgroups features, including cpusets and memory controller.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500114circular-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.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700120connector/
121 - docs on the netlink based userspace<->kernel space communication mod.
122console/
123 - documentation on Linux console drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124cpu-freq/
125 - info on CPU frequency and voltage scaling.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700126cpu-hotplug.txt
127 - document describing CPU hotplug support in the Linux kernel.
128cpu-load.txt
129 - document describing how CPU load statistics are collected.
Venkatesh Pallipadife8e2882008-02-14 00:16:13 -0500130cpuidle/
131 - info on CPU_IDLE, CPU idle state management subsystem.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700132cputopology.txt
133 - documentation on how CPU topology info is exported via sysfs.
Bob Pearsonfbedceb2012-03-23 15:02:22 -0700134crc32.txt
135 - brief tutorial on CRC computation
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136cris/
137 - directory with info about Linux on CRIS architecture.
138crypto/
139 - directory with info on the Crypto API.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700140dcdbas.txt
141 - information on the Dell Systems Management Base Driver.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142debugging-modules.txt
143 - some notes on debugging modules after Linux 2.6.3.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500144debugging-via-ohci1394.txt
145 - how to use firewire like a hardware debugger memory reader.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700146dell_rbu.txt
147 - document demonstrating the use of the Dell Remote BIOS Update driver.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500148development-process/
149 - how to work with the mainline kernel development process.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150device-mapper/
151 - directory with info on Device Mapper.
152devices.txt
153 - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500154devicetree/
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
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700162dontdiff
163 - file containing a list of files that should never be diff'ed.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164driver-model/
165 - directory with info about Linux driver model.
166dvb/
167 - info on Linux Digital Video Broadcast (DVB) subsystem.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500168dynamic-debug-howto.txt
169 - how to use the dynamic debug (dyndbg) feature.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170early-userspace/
171 - info about initramfs, klibc, and userspace early during boot.
Adrian Bunk4a6b88c2008-02-07 00:13:33 -0800172edac.txt
173 - information on EDAC - Error Detection And Correction
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174eisa.txt
175 - info on EISA bus support.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500176email-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.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700180fault-injection/
181 - dir with docs about the fault injection capabilities infrastructure.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182fb/
183 - directory with info on the frame buffer graphics abstraction layer.
184filesystems/
J. Bruce Fields4f3b19c2007-09-24 18:52:09 -0400185 - info on the vfs and the various filesystems that Linux supports.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186firmware_class/
187 - request_firmware() hotplug interface info.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500188flexible-arrays.txt
189 - how to make use of flexible sized arrays in linux
Adrian Bunk0868ff72008-02-03 15:54:28 +0200190frv/
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700191 - Fujitsu FR-V Linux documentation.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500192futex-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
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700196gpio.txt
197 - overview of GPIO (General Purpose Input/Output) access conventions.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500198hid/
199 - directory with information on human interface devices
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200highuid.txt
201 - notes on the change from 16 bit to 32 bit user/group IDs.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500202hwspinlock.txt
203 - hardware spinlock provides hardware assistance for synchronization
Thomas Gleixner3833eec2008-03-05 18:28:15 +0100204timers/
205 - info on the timer related topics
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206hw_random.txt
207 - info on Linux support for random number generator in i8xx chipsets.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700208hwmon/
209 - directory with docs on various hardware monitoring drivers.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210i2c/
211 - directory with info about the I2C bus/protocol (2 wire, kHz speed).
212i2o/
213 - directory with info about the Linux I2O subsystem.
Uwe Hermann71cced62008-10-20 09:32:21 -0700214x86/i386/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 - directory with info about Linux on Intel 32 bit architecture.
216ia64/
217 - directory with info about Linux on Intel 64 bit architecture.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700218infiniband/
219 - directory with documents concerning Linux InfiniBand support.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500220init.txt
221 - what to do when the kernel can't find the 1st process to run.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222initrd.txt
223 - how to use the RAM disk as an initial/temporary root filesystem.
224input/
225 - info on Linux input device support.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500226intel_txt.txt
227 - info on intel Trusted Execution Technology (intel TXT).
Randy Dunlap9fe41e42010-07-19 22:20:27 +0000228io-mapping.txt
229 - description of io_mapping functions in linux/io-mapping.h
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230io_ordering.txt
231 - info on ordering I/O writes to memory-mapped addresses.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700232ioctl/
233 - directory with documents describing various IOCTL calls.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234iostats.txt
235 - info on I/O statistics Linux kernel provides.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700236irqflags-tracing.txt
237 - how to use the irq-flags tracing feature.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238isapnp.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).
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500244ja_JP/
245 - directory with Japanese translations of various documents
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246kbuild/
247 - directory with info about the kernel build process.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700248kdump/
249 - directory with mini HowTo on getting the crash dump code to work.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250kernel-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.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500256kmemcheck.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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262kobject.txt
263 - info of the kobject infrastructure of the Linux kernel.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700264kprobes.txt
265 - documents the kernel probes debugging feature.
266kref.txt
267 - docs on adding reference counters (krefs) to kernel objects.
Carlos Corbachod6ff3652008-02-09 01:32:03 +0000268laptops/
269 - directory with laptop related info and laptop driver documentation.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270ldm.txt
271 - a brief description of LDM (Windows Dynamic Disks).
Antonio Ospite9a684e12011-04-04 15:08:46 -0700272leds/
273 - directory with info about LED handling under Linux.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700274local_ops.txt
275 - semantics and behavior of local atomic operations.
276lockdep-design.txt
277 - documentation on the runtime locking correctness validator.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500278lockstat.txt
279 - info on collecting statistics on locks (and contention).
Jean Delvarefd058732012-10-21 12:05:51 +0200280lockup-watchdogs.txt
281 - info on soft and hard lockup detectors (aka nmi_watchdog).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282logo.gif
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700283 - full colour GIF image of Linux logo (penguin - Tux).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284logo.txt
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700285 - info on creator of above logo & site to get additional images from.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286m68k/
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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290md.txt
291 - info on boot arguments for the multiple devices driver.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500292media-framework.txt
293 - info on media framework, its data structures, functions and usage.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700294memory-barriers.txt
295 - info on Linux kernel memory barriers.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500296memory-devices/
297 - directory with info on parts like the Texas Instruments EMIF driver
Rob Landley5ef43562007-10-16 23:31:25 -0700298memory-hotplug.txt
299 - Hotpluggable memory support, how to use and current status.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300memory.txt
301 - info on typical Linux memory problems.
302mips/
303 - directory with info about Linux on MIPS architecture.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500304misc-devices/
305 - directory with info about devices using the misc dev subsystem
Adrian Hunterdfe86cb2010-08-11 14:17:46 -0700306mmc/
307 - directory with info about the MMC subsystem
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500308mn10300/
309 - directory with info about the mn10300 architecture port
310mtd/
311 - directory with info about memory technology devices (flash)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312mono.txt
313 - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700314mutex-design.txt
315 - info on the generic mutex subsystem.
Pavel Emelyanov2868f892007-11-28 16:21:39 -0800316namespaces/
317 - directory with various information about namespaces
Paul Moore8802f612006-08-03 16:45:49 -0700318netlabel/
319 - directory with information on the NetLabel subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320networking/
321 - directory with info on various aspects of networking with Linux.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500322nfc/
323 - directory relating info about Near Field Communications support.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700324nommu-mmap.txt
325 - documentation about no-mmu memory mapping support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326numastat.txt
327 - info on how to read Numa policy hit/miss statistics in sysfs.
328oops-tracing.txt
329 - how to decode those nasty internal kernel error dump messages.
Jonathan Corbet4047f8b2010-05-12 14:23:48 -0600330padata.txt
331 - An introduction to the "padata" parallel execution API
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332parisc/
333 - directory with info on using Linux on PA-RISC architecture.
334parport.txt
335 - how to use the parallel-port driver.
336parport-lowlevel.txt
337 - description and usage of the low level parallel port functions.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700338pcmcia/
339 - info on the Linux PCMCIA driver.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500340percpu-rw-semaphore.txt
341 - RCU based read-write semaphore optimized for locking for reading
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700342pi-futex.txt
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500343 - documentation on lightweight priority inheritance futexes.
344pinctrl.txt
345 - info on pinctrl subsystem and the PINMUX/PINCONF and drivers
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346pnp.txt
347 - Linux Plug and Play documentation.
348power/
349 - directory with info on Linux PCI power management.
350powerpc/
351 - directory with info on using Linux with the PowerPC.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500352prctl/
353 - directory with info on the priveledge control subsystem
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354preempt-locking.txt
355 - info on locking under a preemptive kernel.
Randy Dunlapb67ad182008-11-12 13:26:55 -0800356printk-formats.txt
357 - how to get printk format specifiers right
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500358pps/
359 - directory with information on the pulse-per-second support
360ptp/
361 - directory with info on support for IEEE 1588 PTP clocks in Linux.
362pwm.txt
363 - info on the pulse width modulation driver subsystem
Sergiu Iordache4126dac2011-08-13 12:34:56 -0700364ramoops.txt
365 - documentation of the ramoops oops/panic logging module.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500366rapidio/
367 - directory with info on RapidIO packet-based fabric interconnect
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700368rbtree.txt
369 - info on what red-black trees are and what they are for.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500370remoteproc.txt
371 - info on how to handle remote processor (e.g. AMP) offloads/usage.
372rfkill.txt
373 - info on the radio frequency kill switch subsystem/support.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700374robust-futex-ABI.txt
375 - documentation of the robust futex ABI.
376robust-futexes.txt
377 - a description of what robust futexes are.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500378rpmsg.txt
379 - info on the Remote Processor Messaging (rpmsg) Framework
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700380rt-mutex-design.txt
381 - description of the RealTime mutex implementation design.
382rt-mutex.txt
383 - desc. of RT-mutex subsystem with PI (Priority Inheritance) support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384rtc.txt
385 - notes on how to use the Real Time Clock (aka CMOS clock) driver.
386s390/
387 - directory with info on using Linux on the IBM S390.
J. Bruce Fields9b8eae72008-02-07 00:13:37 -0800388scheduler/
389 - directory with info on the scheduler.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390scsi/
391 - directory with info on Linux scsi support.
Randy Dunlapd410fa4e2011-05-19 15:59:38 -0700392security/
393 - directory that contains security-related info
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394serial/
395 - directory with info on the low level serial API.
396serial-console.txt
397 - how to set up Linux with a serial line console as the default.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700398sgi-ioc4.txt
399 - description of the SGI IOC4 PCI (multi function) device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400sgi-visws.txt
401 - short blurb on the SGI Visual Workstations.
402sh/
403 - directory with info on porting Linux to a new architecture.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500404smsc_ece1099.txt
405 -info on the smsc Keyboard Scan Expansion/GPIO Expansion device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406sound/
407 - directory with info on sound card support.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700408sparse.txt
409 - info on how to obtain and use the sparse tool for typechecking.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700410spi/
411 - overview of Linux kernel Serial Peripheral Interface (SPI) support.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412spinlocks.txt
413 - info on using spinlocks to provide exclusive access in kernel.
Greg Kroah-Hartman8907e942005-11-18 09:31:15 -0800414stable_api_nonsense.txt
415 - info on why the kernel does not have a stable in-kernel api or abi.
416stable_kernel_rules.txt
417 - rules and procedures for the -stable kernel releases.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500418static-keys.txt
419 - info on how static keys allow debug code in hotpaths via patching
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420svga.txt
421 - short guide on selecting video modes at boot via VGA BIOS.
Rob Landley5ef43562007-10-16 23:31:25 -0700422sysfs-rules.txt
423 - How not to use sysfs.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424sysctl/
425 - directory with info on the /proc/sys/* files.
426sysrq.txt
427 - info on the magic SysRq key.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500428target/
429 - directory with info on generating TCM v4 fabric .ko modules
430thermal/
431 - directory with information on managing thermal issues (CPU/temp)
432trace/
433 - directory with info on tracing technologies within linux
434unaligned-memory-access.txt
435 - info on how to avoid arch breaking unaligned memory access in code.
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700436unicode.txt
437 - info on the Unicode character/font mapping used in Linux.
438unshare.txt
439 - description of the Linux unshare system call.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440usb/
441 - directory with info regarding the Universal Serial Bus.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500442vDSO/
443 - directory with info regarding virtual dynamic shared objects
444vfio.txt
445 - info on Virtual Function I/O used in guest/hypervisor instances.
446vgaarbiter.txt
447 - info on enable/disable the legacy decoding on different VGA devices
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700448video-output.txt
449 - sysfs class driver interface to enable/disable a video output device.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450video4linux/
451 - directory with info regarding video/TV/radio cards and linux.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500452virtual/
453 - directory with information on the various linux virtualizations.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454vm/
455 - directory with info on the Linux vm code.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500456vme_api.txt
457 - file relating info on the VME bus API in linux
Rob Landley5ef43562007-10-16 23:31:25 -0700458volatile-considered-harmful.txt
459 - Why the "volatile" type class should not be used
Jesper Juhlf6b07d32007-07-15 23:41:41 -0700460w1/
461 - directory with documents regarding the 1-wire (w1) subsystem.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462watchdog/
463 - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500464wimax/
465 - directory with info about Intel Wireless Wimax Connections
466workqueue.txt
467 - information on the Concurrency Managed Workqueue implementation
Uwe Hermann71cced62008-10-20 09:32:21 -0700468x86/x86_64/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 - directory with info on Linux support for AMD x86-64 (Hammer) machines.
Paul Gortmaker449e3a72013-02-14 15:20:54 -0500470xtensa/
471 - directory with documents relating to arch/xtensa port/implementation
472xz.txt
473 - how to make use of the XZ data compression within linux kernel
474zh_CN/
475 - directory with Chinese translations of various documents
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476zorro.txt
477 - info on writing drivers for Zorro bus devices found on Amigas.