diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-09-19 08:07:57 -0300 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2016-09-20 18:41:22 -0600 |
| commit | 43fb67a5258c0f3d1d869cb7d72617d87b257c62 (patch) | |
| tree | 78bf35662e96d28da1711e20afe6160d3a375e6b | |
| parent | 609d99a3b72e3964279a068868a212553087eb22 (diff) | |
| download | linux-stable-43fb67a5258c0f3d1d869cb7d72617d87b257c62.tar.gz linux-stable-43fb67a5258c0f3d1d869cb7d72617d87b257c62.tar.bz2 linux-stable-43fb67a5258c0f3d1d869cb7d72617d87b257c62.zip | |
Documentation/HOWTO: update information about generating documentation
The description there are pre-Sphinx. Update it to cover the
new way.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| -rw-r--r-- | Documentation/HOWTO | 28 |
1 files changed, 22 insertions, 6 deletions
diff --git a/Documentation/HOWTO b/Documentation/HOWTO index 31c8df5d20c7..f297d5512885 100644 --- a/Documentation/HOWTO +++ b/Documentation/HOWTO @@ -164,21 +164,37 @@ required reading: apply it to the different development branches of the kernel. 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 -locking properly. The documents will be created in the -Documentation/DocBook/ directory and can be generated as PDF, -Postscript, HTML, and man pages by running: +locking properly. + +All such documents can be generated as PDF or HTML by running: :: make pdfdocs - make psdocs make htmldocs - make mandocs 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 --------------------------- |