Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 43fb67a5 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Jonathan Corbet
Browse files

Documentation/HOWTO: update information about generating documentation 



The description there are pre-Sphinx. Update it to cover the
new way.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 609d99a3

Documentation/HOWTO

+22 −6
Original line number Original line Diff line number Diff line
@@ -164,21 +164,37 @@ required reading: 
    apply it to the different development branches of the kernel.

    apply it to the different development branches of the kernel.





The kernel also has a large number of documents that can be

The kernel also has a large number of documents that can be

automatically generated from the source code itself.  This includes a

automatically generated from the source code itself or from

ReStructuredText markups (ReST), like this one. This includes a

full description of the in-kernel API, and rules on how to handle

full description of the in-kernel API, and rules on how to handle

locking properly.  The documents will be created in the

locking properly.

Documentation/DocBook/ directory and can be generated as PDF,



Postscript, HTML, and man pages by running:

All such documents can be generated as PDF or HTML by running:





::

::





	make pdfdocs

	make pdfdocs

	make psdocs

	make htmldocs

	make htmldocs

	make mandocs





respectively from the main kernel source directory.

respectively from the main kernel source directory.





The documents that uses ReST markup will be generated at Documentation/output.

They can also be generated on LaTeX and ePub formats with:



::



	make latexdocs

	make epubdocs



Currently, there are some documents written on DocBook that are in

the process of conversion to ReST. Such documents will be created in the

Documentation/DocBook/ directory and can be generated also as

Postscript or man pages by running:



::



	make psdocs

	make mandocs





Becoming A Kernel Developer

Becoming A Kernel Developer

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

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