Commit 608ee2ff authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

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: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 7b5f2bd7

Documentation/kernel-docs.txt

+47 −44
Original line number Diff line number Diff line
@@ -32,6 +32,53 @@ Document. 


Enjoy!



Docs at the Linux Kernel tree

-----------------------------



The DocBook books should be built with ``make {htmldocs | psdocs | pdfdocs}``.

The Sphinx books should be built with ``make {htmldocs | pdfdocs | epubdocs}``.



    * Name: **linux/Documentation**



      :Author: Many.

      :Location: Documentation/

      :Keywords: text files, Sphinx, DocBook.

      :Description: Documentation that comes with the kernel sources,

        inside the Documentation directory. Some pages from this document

        (including this document itself) have been moved there, and might

        be more up to date than the web version.



    * Title: **The Kernel Hacking HOWTO**



      :Author: Various Talented People, and Rusty.

      :Location: Documentation/DocBook/kernel-hacking.tmpl

      :Keywords: HOWTO, kernel contexts, deadlock, locking, modules,

        symbols, return conventions.

      :Description: From the Introduction: "Please understand that I

        never wanted to write this document, being grossly underqualified,

        but I always wanted to read it, and this was the only way. I

        simply explain some best practices, and give reading entry-points

        into the kernel sources. I avoid implementation details: that's

        what the code is for, and I ignore whole tracts of useful

        routines. This document assumes familiarity with C, and an

        understanding of what the kernel is, and how it is used. It was

        originally written for the 2.3 kernels, but nearly all of it

        applies to 2.2 too; 2.0 is slightly different".



    * Title: **Linux Kernel Locking HOWTO**



      :Author: Various Talented People, and Rusty.

      :Location: Documentation/DocBook/kernel-locking.tmpl

      :Keywords: locks, locking, spinlock, semaphore, atomic, race

        condition, bottom halves, tasklets, softirqs.

      :Description: The title says it all: document describing the

        locking system in the Linux Kernel either in uniprocessor or SMP

        systems.

      :Notes: "It was originally written for the later (>2.3.47) 2.3

        kernels, but most of it applies to 2.2 too; 2.0 is slightly

        different". Freely redistributable under the conditions of the GNU

        General Public License.



On-line docs

------------
@@ -268,24 +315,6 @@ On-line docs 
        want a mechanism that is scalable. This means a large number of

        inactive FDs cost very little in memory and CPU time to manage".



    * Title: **The Kernel Hacking HOWTO**



      :Author: Various Talented People, and Rusty.

      :Location: in kernel tree, Documentation/DocBook/kernel-hacking.tmpl

        (must be built as "make {htmldocs | psdocs | pdfdocs})

      :Keywords: HOWTO, kernel contexts, deadlock, locking, modules,

        symbols, return conventions.

      :Description: From the Introduction: "Please understand that I

        never wanted to write this document, being grossly underqualified,

        but I always wanted to read it, and this was the only way. I

        simply explain some best practices, and give reading entry-points

        into the kernel sources. I avoid implementation details: that's

        what the code is for, and I ignore whole tracts of useful

        routines. This document assumes familiarity with C, and an

        understanding of what the kernel is, and how it is used. It was

        originally written for the 2.3 kernels, but nearly all of it

        applies to 2.2 too; 2.0 is slightly different".



    * Title: **Writing an ALSA Driver**



      :Author: Takashi Iwai <tiwai@suse.de>
@@ -304,21 +333,6 @@ On-line docs 
        a brief description of some of the acronyms and terms you may hear

        during discussion of the Linux kernel".



    * Title: **Linux Kernel Locking HOWTO**



      :Author: Various Talented People, and Rusty.

      :Location: in kernel tree, Documentation/DocBook/kernel-locking.tmpl

        (must be built as "make {htmldocs | psdocs | pdfdocs})

      :Keywords: locks, locking, spinlock, semaphore, atomic, race

        condition, bottom halves, tasklets, softirqs.

      :Description: The title says it all: document describing the

        locking system in the Linux Kernel either in uniprocessor or SMP

        systems.

      :Notes: "It was originally written for the later (>2.3.47) 2.3

        kernels, but most of it applies to 2.2 too; 2.0 is slightly

        different". Freely redistributable under the conditions of the GNU

        General Public License.



    * Title: **Global spinlock list and usage**



      :Author: Rick Lindsley.
@@ -565,17 +579,6 @@ Published books 
Miscellaneous

-------------



    * Name: **linux/Documentation**



      :Author: Many.

      :URL: Just look inside your kernel sources.

      :Keywords: anything, DocBook.

      :Description: Documentation that comes with the kernel sources,

        inside the Documentation directory. Some pages from this document

        (including this document itself) have been moved there, and might

        be more up to date than the web version.



    * Name: **Linux Kernel Source Reference**



      :Author: Thomas Graichen.

      :URL: http://marc.info/?l=linux-kernel&m=96446640102205&w=4