00-INDEX 17 KB

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