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