diff options
Diffstat (limited to 'Documentation')
1893 files changed, 392333 insertions, 0 deletions
diff --git a/Documentation/00-INDEX b/Documentation/00-INDEX new file mode 100644 index 00000000000..65bbd262239 --- /dev/null +++ b/Documentation/00-INDEX @@ -0,0 +1,352 @@ + +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. +Please try and keep the descriptions small enough to fit on one line. + Thanks -- Paul G. + +Following translations are available on the WWW: + + - Japanese, maintained by the JF Project (JF@linux.or.jp), at + http://www.linux.or.jp/JF/ + +00-INDEX + - this file. +ABI/ + - info on kernel <-> userspace ABI and relative interface stability. + +BUG-HUNTING + - brute force method of doing binary search of patches to find bug. +Changes + - list of changes that break older software packages. +CodingStyle + - how the boss likes the C code in the kernel to look. +development-process/ + - An extended tutorial on how to work with the kernel development + process. +DMA-API.txt + - DMA API, pci_ API & extensions for non-consistent memory machines. +DMA-ISA-LPC.txt + - How to do DMA with ISA (and LPC) devices. +DocBook/ + - directory with DocBook templates etc. for kernel documentation. +HOWTO + - the process and procedures of how to do Linux kernel development. +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. +IRQ.txt + - description of what an IRQ is. +ManagementStyle + - how to (attempt to) manage kernel hackers. +RCU/ + - directory with info on RCU (read-copy update). +SAK.txt + - info on Secure Attention Keys. +SM501.txt + - Silicon Motion SM501 multimedia companion chip +SecurityBugs + - procedure for reporting security bugs found in the kernel. +SubmitChecklist + - Linux kernel patch submission checklist. +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. +accounting/ + - documentation on accounting and taskstats. +acpi/ + - info on ACPI-specific hooks in the kernel. +aoe/ + - description of AoE (ATA over Ethernet) along with config examples. +applying-patches.txt + - description of various trees and how to apply their patches. +arm/ + - directory with info about Linux on the ARM architecture. +atomic_ops.txt + - semantics and behavior of atomic and bitmask operations. +auxdisplay/ + - misc. LCD driver documentation (cfag12864b, ks0108). +basic_profiling.txt + - basic instructions for those who wants to profile Linux kernel. +binfmt_misc.txt + - info on the kernel support for extra binary formats. +blackfin/ + - directory with documentation for the Blackfin arch. +block/ + - info on the Block I/O (BIO) layer. +blockdev/ + - info on block devices & drivers +btmrvl.txt + - info on Marvell Bluetooth driver usage. +bus-virt-phys-mapping.txt + - how to access I/O mapped memory from within device drivers. +cachetlb.txt + - describes the cache/TLB flushing interfaces Linux uses. +cdrom/ + - directory with information on the CD-ROM drivers that Linux has. +cgroups/ + - cgroups features, including cpusets and memory controller. +connector/ + - docs on the netlink based userspace<-> |