diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-09-20 07:36:40 -0400 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2016-09-20 20:53:43 -0400 |
| commit | 608ee2ff563f245eb4f8e7c06d01d203b59a640f (patch) | |
| tree | 96d350ad6ee34fbc0a227fc93d38157c4bedc7fc | |
| parent | 7b5f2bd74cb97917f819e52b1e3d4724c9c18974 (diff) | |
Documentation/kernel-docs.txt: move in-kernel docs
There are three places where it mentions in-kernel docs.
Move them to a separate topic.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| -rw-r--r-- | Documentation/kernel-docs.txt | 91 |
1 files changed, 47 insertions, 44 deletions
diff --git a/Documentation/kernel-docs.txt b/Documentation/kernel-docs.txt index 4985c433c237..89508ba0b9c9 100644 --- a/Documentation/kernel-docs.txt +++ b/Documentation/kernel-docs.txt | |||
| @@ -32,6 +32,53 @@ Document. | |||
| 32 | 32 | ||
| 33 | Enjoy! | 33 | Enjoy! |
| 34 | 34 | ||
| 35 | Docs at the Linux Kernel tree | ||
| 36 | ----------------------------- | ||
| 37 | |||
| 38 | The DocBook books should be built with ``make {htmldocs | psdocs | pdfdocs}``. | ||
| 39 | The Sphinx books should be built with ``make {htmldocs | pdfdocs | epubdocs}``. | ||
| 40 | |||
| 41 | * Name: **linux/Documentation** | ||
| 42 | |||
| 43 | :Author: Many. | ||
| 44 | :Location: Documentation/ | ||
| 45 | :Keywords: text files, Sphinx, DocBook. | ||
| 46 | :Description: Documentation that comes with the kernel sources, | ||
| 47 | inside the Documentation directory. Some pages from this document | ||
| 48 | (including this document itself) have been moved there, and might | ||
| 49 | be more up to date than the web version. | ||
| 50 | |||
| 51 | * Title: **The Kernel Hacking HOWTO** | ||
| 52 | |||
| 53 | :Author: Various Talented People, and Rusty. | ||
| 54 | :Location: Documentation/DocBook/kernel-hacking.tmpl | ||
| 55 | :Keywords: HOWTO, kernel contexts, deadlock, locking, modules, | ||
| 56 | symbols, return conventions. | ||
| 57 | :Description: From the Introduction: "Please understand that I | ||
| 58 | never wanted to write this document, being grossly underqualified, | ||
| 59 | but I always wanted to read it, and this was the only way. I | ||
| 60 | simply explain some best practices, and give reading entry-points | ||
| 61 | into the kernel sources. I avoid implementation details: that's | ||
| 62 | what the code is for, and I ignore whole tracts of useful | ||
| 63 | routines. This document assumes familiarity with C, and an | ||
| 64 | understanding of what the kernel is, and how it is used. It was | ||
| 65 | originally written for the 2.3 kernels, but nearly all of it | ||
| 66 | applies to 2.2 too; 2.0 is slightly different". | ||
| 67 | |||
| 68 | * Title: **Linux Kernel Locking HOWTO** | ||
| 69 | |||
| 70 | :Author: Various Talented People, and Rusty. | ||
| 71 | :Location: Documentation/DocBook/kernel-locking.tmpl | ||
| 72 | :Keywords: locks, locking, spinlock, semaphore, atomic, race | ||
| 73 | condition, bottom halves, tasklets, softirqs. | ||
| 74 | :Description: The title says it all: document describing the | ||
| 75 | locking system in the Linux Kernel either in uniprocessor or SMP | ||
| 76 | systems. | ||
| 77 | :Notes: "It was originally written for the later (>2.3.47) 2.3 | ||
| 78 | kernels, but most of it applies to 2.2 too; 2.0 is slightly | ||
| 79 | different". Freely redistributable under the conditions of the GNU | ||
| 80 | General Public License. | ||
| 81 | |||
| 35 | On-line docs | 82 | On-line docs |
| 36 | ------------ | 83 | ------------ |
| 37 | 84 | ||
| @@ -268,24 +315,6 @@ On-line docs | |||
| 268 | want a mechanism that is scalable. This means a large number of | 315 | want a mechanism that is scalable. This means a large number of |
| 269 | inactive FDs cost very little in memory and CPU time to manage". | 316 | inactive FDs cost very little in memory and CPU time to manage". |
| 270 | 317 | ||
| 271 | * Title: **The Kernel Hacking HOWTO** | ||
| 272 | |||
| 273 | :Author: Various Talented People, and Rusty. | ||
| 274 | :Location: in kernel tree, Documentation/DocBook/kernel-hacking.tmpl | ||
| 275 | (must be built as "make {htmldocs | psdocs | pdfdocs}) | ||
| 276 | :Keywords: HOWTO, kernel contexts, deadlock, locking, modules, | ||
| 277 | symbols, return conventions. | ||
| 278 | :Description: From the Introduction: "Please understand that I | ||
| 279 | never wanted to write this document, being grossly underqualified, | ||
| 280 | but I always wanted to read it, and this was the only way. I | ||
| 281 | simply explain some best practices, and give reading entry-points | ||
| 282 | into the kernel sources. I avoid implementation details: that's | ||
| 283 | what the code is for, and I ignore whole tracts of useful | ||
| 284 | routines. This document assumes familiarity with C, and an | ||
| 285 | understanding of what the kernel is, and how it is used. It was | ||
| 286 | originally written for the 2.3 kernels, but nearly all of it | ||
| 287 | applies to 2.2 too; 2.0 is slightly different". | ||
| 288 | |||
| 289 | * Title: **Writing an ALSA Driver** | 318 | * Title: **Writing an ALSA Driver** |
| 290 | 319 | ||
| 291 | :Author: Takashi Iwai <tiwai@suse.de> | 320 | :Author: Takashi Iwai <tiwai@suse.de> |
| @@ -304,21 +333,6 @@ On-line docs | |||
| 304 | a brief description of some of the acronyms and terms you may hear | 333 | a brief description of some of the acronyms and terms you may hear |
| 305 | during discussion of the Linux kernel". | 334 | during discussion of the Linux kernel". |
| 306 | 335 | ||
| 307 | * Title: **Linux Kernel Locking HOWTO** | ||
| 308 | |||
| 309 | :Author: Various Talented People, and Rusty. | ||
| 310 | :Location: in kernel tree, Documentation/DocBook/kernel-locking.tmpl | ||
| 311 | (must be built as "make {htmldocs | psdocs | pdfdocs}) | ||
| 312 | :Keywords: locks, locking, spinlock, semaphore, atomic, race | ||
| 313 | condition, bottom halves, tasklets, softirqs. | ||
| 314 | :Description: The title says it all: document describing the | ||
| 315 | locking system in the Linux Kernel either in uniprocessor or SMP | ||
| 316 | systems. | ||
| 317 | :Notes: "It was originally written for the later (>2.3.47) 2.3 | ||
| 318 | kernels, but most of it applies to 2.2 too; 2.0 is slightly | ||
| 319 | different". Freely redistributable under the conditions of the GNU | ||
| 320 | General Public License. | ||
| 321 | |||
| 322 | * Title: **Global spinlock list and usage** | 336 | * Title: **Global spinlock list and usage** |
| 323 | 337 | ||
| 324 | :Author: Rick Lindsley. | 338 | :Author: Rick Lindsley. |
| @@ -565,17 +579,6 @@ Published books | |||
| 565 | Miscellaneous | 579 | Miscellaneous |
| 566 | ------------- | 580 | ------------- |
| 567 | 581 | ||
| 568 | * Name: **linux/Documentation** | ||
| 569 | |||
| 570 | :Author: Many. | ||
| 571 | :URL: Just look inside your kernel sources. | ||
| 572 | :Keywords: anything, DocBook. | ||
| 573 | :Description: Documentation that comes with the kernel sources, | ||
| 574 | inside the Documentation directory. Some pages from this document | ||
| 575 | (including this document itself) have been moved there, and might | ||
| 576 | be more up to date than the web version. | ||
| 577 | |||
| 578 | * Name: **Linux Kernel Source Reference** | ||
| 579 | 582 | ||
| 580 | :Author: Thomas Graichen. | 583 | :Author: Thomas Graichen. |
| 581 | :URL: http://marc.info/?l=linux-kernel&m=96446640102205&w=4 | 584 | :URL: http://marc.info/?l=linux-kernel&m=96446640102205&w=4 |
