00-INDEX 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355
  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 try and 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 boss likes the C code in the kernel to look.
  19. development-process/
  20. - An extended tutorial on how to work with the kernel development
  21. process.
  22. DMA-API.txt
  23. - DMA API, pci_ API & extensions for non-consistent memory machines.
  24. DMA-ISA-LPC.txt
  25. - How to do DMA with ISA (and LPC) devices.
  26. DocBook/
  27. - directory with DocBook templates etc. for kernel documentation.
  28. HOWTO
  29. - the process and procedures of how to do Linux kernel development.
  30. IPMI.txt
  31. - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
  32. IRQ-affinity.txt
  33. - how to select which CPU(s) handle which interrupt events on SMP.
  34. IRQ.txt
  35. - description of what an IRQ is.
  36. ManagementStyle
  37. - how to (attempt to) manage kernel hackers.
  38. RCU/
  39. - directory with info on RCU (read-copy update).
  40. SAK.txt
  41. - info on Secure Attention Keys.
  42. SM501.txt
  43. - Silicon Motion SM501 multimedia companion chip
  44. SecurityBugs
  45. - procedure for reporting security bugs found in the kernel.
  46. SubmitChecklist
  47. - Linux kernel patch submission checklist.
  48. SubmittingDrivers
  49. - procedure to get a new driver source included into the kernel tree.
  50. SubmittingPatches
  51. - procedure to get a source patch included into the kernel tree.
  52. VGA-softcursor.txt
  53. - how to change your VGA cursor from a blinking underscore.
  54. accounting/
  55. - documentation on accounting and taskstats.
  56. acpi/
  57. - info on ACPI-specific hooks in the kernel.
  58. aoe/
  59. - description of AoE (ATA over Ethernet) along with config examples.
  60. applying-patches.txt
  61. - description of various trees and how to apply their patches.
  62. arm/
  63. - directory with info about Linux on the ARM architecture.
  64. atomic_ops.txt
  65. - semantics and behavior of atomic and bitmask operations.
  66. auxdisplay/
  67. - misc. LCD driver documentation (cfag12864b, ks0108).
  68. basic_profiling.txt
  69. - basic instructions for those who wants to profile Linux kernel.
  70. bif-framework.txt
  71. - information about MIPI-BIF support in the Linux kernel.
  72. binfmt_misc.txt
  73. - info on the kernel support for extra binary formats.
  74. blackfin/
  75. - directory with documentation for the Blackfin arch.
  76. block/
  77. - info on the Block I/O (BIO) layer.
  78. blockdev/
  79. - info on block devices & drivers
  80. btmrvl.txt
  81. - info on Marvell Bluetooth driver usage.
  82. bus-virt-phys-mapping.txt
  83. - how to access I/O mapped memory from within device drivers.
  84. cachetlb.txt
  85. - describes the cache/TLB flushing interfaces Linux uses.
  86. cdrom/
  87. - directory with information on the CD-ROM drivers that Linux has.
  88. cgroups/
  89. - cgroups features, including cpusets and memory controller.
  90. connector/
  91. - docs on the netlink based userspace<->kernel space communication mod.
  92. console/
  93. - documentation on Linux console drivers.
  94. cpu-freq/
  95. - info on CPU frequency and voltage scaling.
  96. cpu-hotplug.txt
  97. - document describing CPU hotplug support in the Linux kernel.
  98. cpu-load.txt
  99. - document describing how CPU load statistics are collected.
  100. cpuidle/
  101. - info on CPU_IDLE, CPU idle state management subsystem.
  102. cputopology.txt
  103. - documentation on how CPU topology info is exported via sysfs.
  104. crc32.txt
  105. - brief tutorial on CRC computation
  106. cris/
  107. - directory with info about Linux on CRIS architecture.
  108. crypto/
  109. - directory with info on the Crypto API.
  110. dcdbas.txt
  111. - information on the Dell Systems Management Base Driver.
  112. debugging-modules.txt
  113. - some notes on debugging modules after Linux 2.6.3.
  114. dell_rbu.txt
  115. - document demonstrating the use of the Dell Remote BIOS Update driver.
  116. device-mapper/
  117. - directory with info on Device Mapper.
  118. devices.txt
  119. - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
  120. dontdiff
  121. - file containing a list of files that should never be diff'ed.
  122. driver-model/
  123. - directory with info about Linux driver model.
  124. dvb/
  125. - info on Linux Digital Video Broadcast (DVB) subsystem.
  126. early-userspace/
  127. - info about initramfs, klibc, and userspace early during boot.
  128. edac.txt
  129. - information on EDAC - Error Detection And Correction
  130. eisa.txt
  131. - info on EISA bus support.
  132. fault-injection/
  133. - dir with docs about the fault injection capabilities infrastructure.
  134. fb/
  135. - directory with info on the frame buffer graphics abstraction layer.
  136. feature-removal-schedule.txt
  137. - list of files and features that are going to be removed.
  138. filesystems/
  139. - info on the vfs and the various filesystems that Linux supports.
  140. firmware_class/
  141. - request_firmware() hotplug interface info.
  142. frv/
  143. - Fujitsu FR-V Linux documentation.
  144. gpio.txt
  145. - overview of GPIO (General Purpose Input/Output) access conventions.
  146. highuid.txt
  147. - notes on the change from 16 bit to 32 bit user/group IDs.
  148. timers/
  149. - info on the timer related topics
  150. hw_random.txt
  151. - info on Linux support for random number generator in i8xx chipsets.
  152. hwmon/
  153. - directory with docs on various hardware monitoring drivers.
  154. i2c/
  155. - directory with info about the I2C bus/protocol (2 wire, kHz speed).
  156. i2o/
  157. - directory with info about the Linux I2O subsystem.
  158. x86/i386/
  159. - directory with info about Linux on Intel 32 bit architecture.
  160. ia64/
  161. - directory with info about Linux on Intel 64 bit architecture.
  162. infiniband/
  163. - directory with documents concerning Linux InfiniBand support.
  164. initrd.txt
  165. - how to use the RAM disk as an initial/temporary root filesystem.
  166. input/
  167. - info on Linux input device support.
  168. io-mapping.txt
  169. - description of io_mapping functions in linux/io-mapping.h
  170. io_ordering.txt
  171. - info on ordering I/O writes to memory-mapped addresses.
  172. ioctl/
  173. - directory with documents describing various IOCTL calls.
  174. iostats.txt
  175. - info on I/O statistics Linux kernel provides.
  176. irqflags-tracing.txt
  177. - how to use the irq-flags tracing feature.
  178. isapnp.txt
  179. - info on Linux ISA Plug & Play support.
  180. isdn/
  181. - directory with info on the Linux ISDN support, and supported cards.
  182. java.txt
  183. - info on the in-kernel binary support for Java(tm).
  184. kbuild/
  185. - directory with info about the kernel build process.
  186. kdump/
  187. - directory with mini HowTo on getting the crash dump code to work.
  188. kernel-doc-nano-HOWTO.txt
  189. - mini HowTo on generation and location of kernel documentation files.
  190. kernel-docs.txt
  191. - listing of various WWW + books that document kernel internals.
  192. kernel-parameters.txt
  193. - summary listing of command line / boot prompt args for the kernel.
  194. kobject.txt
  195. - info of the kobject infrastructure of the Linux kernel.
  196. kprobes.txt
  197. - documents the kernel probes debugging feature.
  198. kref.txt
  199. - docs on adding reference counters (krefs) to kernel objects.
  200. laptops/
  201. - directory with laptop related info and laptop driver documentation.
  202. ldm.txt
  203. - a brief description of LDM (Windows Dynamic Disks).
  204. leds/
  205. - directory with info about LED handling under Linux.
  206. local_ops.txt
  207. - semantics and behavior of local atomic operations.
  208. lockdep-design.txt
  209. - documentation on the runtime locking correctness validator.
  210. logo.gif
  211. - full colour GIF image of Linux logo (penguin - Tux).
  212. logo.txt
  213. - info on creator of above logo & site to get additional images from.
  214. m68k/
  215. - directory with info about Linux on Motorola 68k architecture.
  216. magic-number.txt
  217. - list of magic numbers used to mark/protect kernel data structures.
  218. md.txt
  219. - info on boot arguments for the multiple devices driver.
  220. memory-barriers.txt
  221. - info on Linux kernel memory barriers.
  222. memory-hotplug.txt
  223. - Hotpluggable memory support, how to use and current status.
  224. memory.txt
  225. - info on typical Linux memory problems.
  226. mips/
  227. - directory with info about Linux on MIPS architecture.
  228. mmc/
  229. - directory with info about the MMC subsystem
  230. mono.txt
  231. - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
  232. mutex-design.txt
  233. - info on the generic mutex subsystem.
  234. namespaces/
  235. - directory with various information about namespaces
  236. netlabel/
  237. - directory with information on the NetLabel subsystem.
  238. networking/
  239. - directory with info on various aspects of networking with Linux.
  240. nmi_watchdog.txt
  241. - info on NMI watchdog for SMP systems.
  242. nommu-mmap.txt
  243. - documentation about no-mmu memory mapping support.
  244. numastat.txt
  245. - info on how to read Numa policy hit/miss statistics in sysfs.
  246. oops-tracing.txt
  247. - how to decode those nasty internal kernel error dump messages.
  248. padata.txt
  249. - An introduction to the "padata" parallel execution API
  250. parisc/
  251. - directory with info on using Linux on PA-RISC architecture.
  252. parport.txt
  253. - how to use the parallel-port driver.
  254. parport-lowlevel.txt
  255. - description and usage of the low level parallel port functions.
  256. pcmcia/
  257. - info on the Linux PCMCIA driver.
  258. pi-futex.txt
  259. - documentation on lightweight PI-futexes.
  260. pnp.txt
  261. - Linux Plug and Play documentation.
  262. power/
  263. - directory with info on Linux PCI power management.
  264. powerpc/
  265. - directory with info on using Linux with the PowerPC.
  266. preempt-locking.txt
  267. - info on locking under a preemptive kernel.
  268. printk-formats.txt
  269. - how to get printk format specifiers right
  270. prio_tree.txt
  271. - info on radix-priority-search-tree use for indexing vmas.
  272. ramoops.txt
  273. - documentation of the ramoops oops/panic logging module.
  274. rbtree.txt
  275. - info on what red-black trees are and what they are for.
  276. robust-futex-ABI.txt
  277. - documentation of the robust futex ABI.
  278. robust-futexes.txt
  279. - a description of what robust futexes are.
  280. rt-mutex-design.txt
  281. - description of the RealTime mutex implementation design.
  282. rt-mutex.txt
  283. - desc. of RT-mutex subsystem with PI (Priority Inheritance) support.
  284. rtc.txt
  285. - notes on how to use the Real Time Clock (aka CMOS clock) driver.
  286. s390/
  287. - directory with info on using Linux on the IBM S390.
  288. scheduler/
  289. - directory with info on the scheduler.
  290. scsi/
  291. - directory with info on Linux scsi support.
  292. security/
  293. - directory that contains security-related info
  294. serial/
  295. - directory with info on the low level serial API.
  296. serial-console.txt
  297. - how to set up Linux with a serial line console as the default.
  298. sgi-ioc4.txt
  299. - description of the SGI IOC4 PCI (multi function) device.
  300. sgi-visws.txt
  301. - short blurb on the SGI Visual Workstations.
  302. sh/
  303. - directory with info on porting Linux to a new architecture.
  304. sound/
  305. - directory with info on sound card support.
  306. sparc/
  307. - directory with info on using Linux on Sparc architecture.
  308. sparse.txt
  309. - info on how to obtain and use the sparse tool for typechecking.
  310. spi/
  311. - overview of Linux kernel Serial Peripheral Interface (SPI) support.
  312. spinlocks.txt
  313. - info on using spinlocks to provide exclusive access in kernel.
  314. stable_api_nonsense.txt
  315. - info on why the kernel does not have a stable in-kernel api or abi.
  316. stable_kernel_rules.txt
  317. - rules and procedures for the -stable kernel releases.
  318. svga.txt
  319. - short guide on selecting video modes at boot via VGA BIOS.
  320. sysfs-rules.txt
  321. - How not to use sysfs.
  322. sysctl/
  323. - directory with info on the /proc/sys/* files.
  324. sysrq.txt
  325. - info on the magic SysRq key.
  326. telephony/
  327. - directory with info on telephony (e.g. voice over IP) support.
  328. unicode.txt
  329. - info on the Unicode character/font mapping used in Linux.
  330. unshare.txt
  331. - description of the Linux unshare system call.
  332. usb/
  333. - directory with info regarding the Universal Serial Bus.
  334. video-output.txt
  335. - sysfs class driver interface to enable/disable a video output device.
  336. video4linux/
  337. - directory with info regarding video/TV/radio cards and linux.
  338. vm/
  339. - directory with info on the Linux vm code.
  340. volatile-considered-harmful.txt
  341. - Why the "volatile" type class should not be used
  342. w1/
  343. - directory with documents regarding the 1-wire (w1) subsystem.
  344. watchdog/
  345. - how to auto-reboot Linux if it has "fallen and can't get up". ;-)
  346. x86/x86_64/
  347. - directory with info on Linux support for AMD x86-64 (Hammer) machines.
  348. zorro.txt
  349. - info on writing drivers for Zorro bus devices found on Amigas.