diff options
| author | Jonathan Corbet <corbet@lwn.net> | 2017-05-18 11:03:08 -0600 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2017-05-18 11:03:08 -0600 |
| commit | 6312811be26f4a97fb36f53ffffafa5086833a28 (patch) | |
| tree | 66082d254d384ed1a5ac869f9b5c96aa78bab95b /Documentation/process/changes.rst | |
| parent | 468f8763fea195f27ce851bded540de5c799628d (diff) | |
| parent | 5d47c31b59f6c2c7ddce0fcb1be0f85ad39a56fe (diff) | |
| download | linux-6312811be26f4a97fb36f53ffffafa5086833a28.tar.gz | |
Merge remote-tracking branch 'mauro-exp/docbook3' into death-to-docbook
Mauro says:
This patch series convert the remaining DocBooks to ReST.
The first version was originally
send as 3 patch series:
[PATCH 00/36] Convert DocBook documents to ReST
[PATCH 0/5] Convert more books to ReST
[PATCH 00/13] Get rid of DocBook
The lsm book was added as if it were a text file under
Documentation. The plan is to merge it with another file
under Documentation/security, after both this series and
a security Documentation patch series gets merged.
It also adjusts some Sphinx-pedantic errors/warnings on
some kernel-doc markups.
I also added some patches here to add PDF output for all
existing ReST books.
Diffstat (limited to 'Documentation/process/changes.rst')
| -rw-r--r-- | Documentation/process/changes.rst | 26 |
1 files changed, 5 insertions, 21 deletions
diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst index e25d63f8c0da..3aed751e0cb5 100644 --- a/Documentation/process/changes.rst +++ b/Documentation/process/changes.rst @@ -116,12 +116,11 @@ DevFS has been obsoleted in favour of udev Linux documentation for functions is transitioning to inline documentation via specially-formatted comments near their -definitions in the source. These comments can be combined with the -SGML templates in the Documentation/DocBook directory to make DocBook -files, which can then be converted by DocBook stylesheets to PostScript, -HTML, PDF files, and several other formats. In order to convert from -DocBook format to a format of your choice, you'll need to install Jade as -well as the desired DocBook stylesheets. +definitions in the source. These comments can be combined with ReST +files the Documentation/ directory to make enriched documentation, which can +then be converted to PostScript, HTML, LaTex, ePUB and PDF files. +In order to convert from ReST format to a format of your choice, you'll need +Sphinx. Util-linux ---------- @@ -323,12 +322,6 @@ PDF outputs, it is recommended to use version 1.4.6. functionalities required for ``XeLaTex`` to work. For PDF output you'll also need ``convert(1)`` from ImageMagick (https://www.imagemagick.org). -Other tools ------------ - -In order to produce documentation from DocBook, you'll also need ``xmlto``. -Please notice, however, that we're currently migrating all documents to use -``Sphinx``. Getting updated software ======================== @@ -409,15 +402,6 @@ Quota-tools - <http://sourceforge.net/projects/linuxquota/> -DocBook Stylesheets -------------------- - -- <http://sourceforge.net/projects/docbook/files/docbook-dsssl/> - -XMLTO XSLT Frontend -------------------- - -- <http://cyberelk.net/tim/xmlto/> Intel P6 microcode ------------------ |