aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-12-05 06:41:42 -0500
committerJonathan Corbet <corbet@lwn.net>2016-12-05 16:21:29 -0500
commit79c87c30d0e6d02b2a7d0f1eed372d0979c03930 (patch)
treeec3f971f5863a80f6914b356a3e5ce57f8acb7b0
parentf15c323397f87b978f4057eb1462efcbf487493a (diff)
docs: 00-INDEX: consolidate process/ and admin-guide/ description
Instead of having descriptions for individual files inside the process/ and admin-guide/ documentation, consolidate them into one entry per directory, just like other descriptions inside 00-INDEX. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
-rw-r--r--Documentation/00-INDEX61
1 files changed, 4 insertions, 57 deletions
diff --git a/Documentation/00-INDEX b/Documentation/00-INDEX
index c08de5574d48..02583a1f409c 100644
--- a/Documentation/00-INDEX
+++ b/Documentation/00-INDEX
@@ -14,13 +14,6 @@ Following translations are available on the WWW:
14 - this file. 14 - this file.
15ABI/ 15ABI/
16 - info on kernel <-> userspace ABI and relative interface stability. 16 - info on kernel <-> userspace ABI and relative interface stability.
17
18admin-guide/bug-hunting.rst
19 - brute force method of doing binary search of patches to find bug.
20process/changes.rst
21 - list of changes that break older software packages.
22process/coding-style.rst
23 - how the maintainers expect the C code in the kernel to look.
24DMA-API.txt 17DMA-API.txt
25 - DMA API, pci_ API & extensions for non-consistent memory machines. 18 - DMA API, pci_ API & extensions for non-consistent memory machines.
26DMA-API-HOWTO.txt 19DMA-API-HOWTO.txt
@@ -33,8 +26,6 @@ DocBook/
33 - directory with DocBook templates etc. for kernel documentation. 26 - directory with DocBook templates etc. for kernel documentation.
34EDID/ 27EDID/
35 - directory with info on customizing EDID for broken gfx/displays. 28 - directory with info on customizing EDID for broken gfx/displays.
36process/howto.rst
37 - the process and procedures of how to do Linux kernel development.
38IPMI.txt 29IPMI.txt
39 - info on Linux Intelligent Platform Management Interface (IPMI) Driver. 30 - info on Linux Intelligent Platform Management Interface (IPMI) Driver.
40IRQ-affinity.txt 31IRQ-affinity.txt
@@ -48,32 +39,22 @@ Intel-IOMMU.txt
48Makefile 39Makefile
49 - This file does nothing. Removing it breaks make htmldocs and 40 - This file does nothing. Removing it breaks make htmldocs and
50 make distclean. 41 make distclean.
51process/management-style.rst
52 - how to (attempt to) manage kernel hackers.
53RCU/ 42RCU/
54 - directory with info on RCU (read-copy update). 43 - directory with info on RCU (read-copy update).
55SAK.txt 44SAK.txt
56 - info on Secure Attention Keys. 45 - info on Secure Attention Keys.
57SM501.txt 46SM501.txt
58 - Silicon Motion SM501 multimedia companion chip 47 - Silicon Motion SM501 multimedia companion chip
59admin-guide/security-bugs.rst
60 - procedure for reporting security bugs found in the kernel.
61process/submit-checklist.rst
62 - Linux kernel patch submission checklist.
63process/submitting-drivers.rst
64 - procedure to get a new driver source included into the kernel tree.
65process/submitting-patches.rst
66 - procedure to get a source patch included into the kernel tree.
67VGA-softcursor.txt 48VGA-softcursor.txt
68 - how to change your VGA cursor from a blinking underscore. 49 - how to change your VGA cursor from a blinking underscore.
69accounting/ 50accounting/
70 - documentation on accounting and taskstats. 51 - documentation on accounting and taskstats.
71acpi/ 52acpi/
72 - info on ACPI-specific hooks in the kernel. 53 - info on ACPI-specific hooks in the kernel.
54admin-guide/
55 - info related to Linux users and system admins.
73aoe/ 56aoe/
74 - description of AoE (ATA over Ethernet) along with config examples. 57 - description of AoE (ATA over Ethernet) along with config examples.
75process/applying-patches.rst
76 - description of various trees and how to apply their patches.
77arm/ 58arm/
78 - directory with info about Linux on the ARM architecture. 59 - directory with info about Linux on the ARM architecture.
79arm64/ 60arm64/
@@ -86,8 +67,6 @@ auxdisplay/
86 - misc. LCD driver documentation (cfag12864b, ks0108). 67 - misc. LCD driver documentation (cfag12864b, ks0108).
87backlight/ 68backlight/
88 - directory with info on controlling backlights in flat panel displays 69 - directory with info on controlling backlights in flat panel displays
89admin-guide/bad-memory.rst
90 - how to use kernel parameters to exclude bad RAM regions.
91basic_profiling.txt 70basic_profiling.txt
92 - basic instructions for those who wants to profile Linux kernel. 71 - basic instructions for those who wants to profile Linux kernel.
93bcache.txt 72bcache.txt
@@ -152,12 +131,8 @@ debugging-via-ohci1394.txt
152 - how to use firewire like a hardware debugger memory reader. 131 - how to use firewire like a hardware debugger memory reader.
153dell_rbu.txt 132dell_rbu.txt
154 - document demonstrating the use of the Dell Remote BIOS Update driver. 133 - document demonstrating the use of the Dell Remote BIOS Update driver.
155process/
156 - how to work with the mainline kernel development process.
157device-mapper/ 134device-mapper/
158 - directory with info on Device Mapper. 135 - directory with info on Device Mapper.
159admin-guide/devices.rst
160 - plain ASCII listing of all the nodes in /dev/ with major minor #'s.
161devicetree/ 136devicetree/
162 - directory with info on device tree files used by OF/PowerPC/ARM 137 - directory with info on device tree files used by OF/PowerPC/ARM
163digsig.txt 138digsig.txt
@@ -178,8 +153,6 @@ efi-stub.txt
178 - How to use the EFI boot stub to bypass GRUB or elilo on EFI systems. 153 - How to use the EFI boot stub to bypass GRUB or elilo on EFI systems.
179eisa.txt 154eisa.txt
180 - info on EISA bus support. 155 - info on EISA bus support.
181process/email-clients.rst
182 - info on how to use e-mail to send un-mangled (git) patches.
183extcon/ 156extcon/
184 - directory with porting guide for Android kernel switch driver. 157 - directory with porting guide for Android kernel switch driver.
185fault-injection/ 158fault-injection/
@@ -226,10 +199,6 @@ ia64/
226 - directory with info about Linux on Intel 64 bit architecture. 199 - directory with info about Linux on Intel 64 bit architecture.
227infiniband/ 200infiniband/
228 - directory with documents concerning Linux InfiniBand support. 201 - directory with documents concerning Linux InfiniBand support.
229admin-guide/init.rst
230 - what to do when the kernel can't find the 1st process to run.
231admin-guide/initrd.rst
232 - how to use the RAM disk as an initial/temporary root filesystem.
233input/ 202input/
234 - info on Linux input device support. 203 - info on Linux input device support.
235intel_txt.txt 204intel_txt.txt
@@ -248,20 +217,14 @@ isapnp.txt
248 - info on Linux ISA Plug & Play support. 217 - info on Linux ISA Plug & Play support.
249isdn/ 218isdn/
250 - directory with info on the Linux ISDN support, and supported cards. 219 - directory with info on the Linux ISDN support, and supported cards.
251admin-guide/java.rst
252 - info on the in-kernel binary support for Java(tm).
253ja_JP/ 220ja_JP/
254 - directory with Japanese translations of various documents 221 - directory with Japanese translations of various documents
255kbuild/ 222kbuild/
256 - directory with info about the kernel build process. 223 - directory with info about the kernel build process.
257kdump/ 224kdump/
258 - directory with mini HowTo on getting the crash dump code to work. 225 - directory with mini HowTo on getting the crash dump code to work.
259process/kernel-docs.rst
260 - listing of various WWW + books that document kernel internals.
261doc-guide/ 226doc-guide/
262 - how to write and format reStructuredText kernel documentation 227 - how to write and format reStructuredText kernel documentation
263admin-guide/kernel-parameters.rst
264 - summary listing of command line / boot prompt args for the kernel.
265kernel-per-CPU-kthreads.txt 228kernel-per-CPU-kthreads.txt
266 - List of all per-CPU kthreads and how they introduce jitter. 229 - List of all per-CPU kthreads and how they introduce jitter.
267kmemcheck.txt 230kmemcheck.txt
@@ -302,8 +265,6 @@ magic-number.txt
302 - list of magic numbers used to mark/protect kernel data structures. 265 - list of magic numbers used to mark/protect kernel data structures.
303mailbox.txt 266mailbox.txt
304 - How to write drivers for the common mailbox framework (IPC). 267 - How to write drivers for the common mailbox framework (IPC).
305admin-guide/md.rst
306 - info on boot arguments for the multiple devices driver.
307media-framework.txt 268media-framework.txt
308 - info on media framework, its data structures, functions and usage. 269 - info on media framework, its data structures, functions and usage.
309memory-barriers.txt 270memory-barriers.txt
@@ -326,8 +287,6 @@ module-signing.txt
326 - Kernel module signing for increased security when loading modules. 287 - Kernel module signing for increased security when loading modules.
327mtd/ 288mtd/
328 - directory with info about memory technology devices (flash) 289 - directory with info about memory technology devices (flash)
329admin-guide/mono.rst
330 - how to execute Mono-based .NET binaries with the help of BINFMT_MISC.
331namespaces/ 290namespaces/
332 - directory with various information about namespaces 291 - directory with various information about namespaces
333netlabel/ 292netlabel/
@@ -340,8 +299,6 @@ nommu-mmap.txt
340 - documentation about no-mmu memory mapping support. 299 - documentation about no-mmu memory mapping support.
341numastat.txt 300numastat.txt
342 - info on how to read Numa policy hit/miss statistics in sysfs. 301 - info on how to read Numa policy hit/miss statistics in sysfs.
343admin-guide/oops-tracing.rst
344 - how to decode those nasty internal kernel error dump messages.
345padata.txt 302padata.txt
346 - An introduction to the "padata" parallel execution API 303 - An introduction to the "padata" parallel execution API
347parisc/ 304parisc/
@@ -372,14 +329,14 @@ preempt-locking.txt
372 - info on locking under a preemptive kernel. 329 - info on locking under a preemptive kernel.
373printk-formats.txt 330printk-formats.txt
374 - how to get printk format specifiers right 331 - how to get printk format specifiers right
332process/
333 - how to work with the mainline kernel development process.
375pps/ 334pps/
376 - directory with information on the pulse-per-second support 335 - directory with information on the pulse-per-second support
377ptp/ 336ptp/
378 - directory with info on support for IEEE 1588 PTP clocks in Linux. 337 - directory with info on support for IEEE 1588 PTP clocks in Linux.
379pwm.txt 338pwm.txt
380 - info on the pulse width modulation driver subsystem 339 - info on the pulse width modulation driver subsystem
381admin-guide/ramoops.rst
382 - documentation of the ramoops oops/panic logging module.
383rapidio/ 340rapidio/
384 - directory with info on RapidIO packet-based fabric interconnect 341 - directory with info on RapidIO packet-based fabric interconnect
385rbtree.txt 342rbtree.txt
@@ -406,8 +363,6 @@ security/
406 - directory that contains security-related info 363 - directory that contains security-related info
407serial/ 364serial/
408 - directory with info on the low level serial API. 365 - directory with info on the low level serial API.
409admin-guide/serial-console.rst
410 - how to set up Linux with a serial line console as the default.
411sgi-ioc4.txt 366sgi-ioc4.txt
412 - description of the SGI IOC4 PCI (multi function) device. 367 - description of the SGI IOC4 PCI (multi function) device.
413sh/ 368sh/
@@ -420,10 +375,6 @@ sparse.txt
420 - info on how to obtain and use the sparse tool for typechecking. 375 - info on how to obtain and use the sparse tool for typechecking.
421spi/ 376spi/
422 - overview of Linux kernel Serial Peripheral Interface (SPI) support. 377 - overview of Linux kernel Serial Peripheral Interface (SPI) support.
423process/stable-api-nonsense.rst
424 - info on why the kernel does not have a stable in-kernel api or abi.
425process/stable-kernel-rules.rst
426 - rules and procedures for the -stable kernel releases.
427static-keys.txt 378static-keys.txt
428 - info on how static keys allow debug code in hotpaths via patching 379 - info on how static keys allow debug code in hotpaths via patching
429svga.txt 380svga.txt
@@ -444,8 +395,6 @@ trace/
444 - directory with info on tracing technologies within linux 395 - directory with info on tracing technologies within linux
445unaligned-memory-access.txt 396unaligned-memory-access.txt
446 - info on how to avoid arch breaking unaligned memory access in code. 397 - info on how to avoid arch breaking unaligned memory access in code.
447admin-guide/unicode.rst
448 - info on the Unicode character/font mapping used in Linux.
449unshare.txt 398unshare.txt
450 - description of the Linux unshare system call. 399 - description of the Linux unshare system call.
451usb/ 400usb/
@@ -464,8 +413,6 @@ vm/
464 - directory with info on the Linux vm code. 413 - directory with info on the Linux vm code.
465vme_api.txt 414vme_api.txt
466 - file relating info on the VME bus API in linux 415 - file relating info on the VME bus API in linux
467process/volatile-considered-harmful.rst
468 - Why the "volatile" type class should not be used
469w1/ 416w1/
470 - directory with documents regarding the 1-wire (w1) subsystem. 417 - directory with documents regarding the 1-wire (w1) subsystem.
471watchdog/ 418watchdog/