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