From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
Jonathan Corbet <corbet@lwn.net>,
Mauro Carvalho Chehab <mchehab@kernel.org>,
David Woodhouse <David.Woodhouse@intel.com>,
Benoit Lemarchand <benoit.lemarchand@gmail.com>,
David Howells <dhowells@redhat.com>,
Markus Heiser <markus.heiser@darmarit.de>,
Jani Nikula <jani.nikula@linux.intel.com>,
LKML <linux-kernel@vger.kernel.org>
Subject: [PATCH 04/17] Changes.rst: add minimal requirements for documentation build
Date: Wed, 14 Sep 2016 20:05:49 -0300 [thread overview]
Message-ID: <38cce9fcfe7fea8f5da435f47a5f883f9e4b9306.1473893776.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <cover.1473893776.git.mchehab@s-opensource.com>
In-Reply-To: <cover.1473893776.git.mchehab@s-opensource.com>
As discussed at linux-doc ML, the best is to keep all documents
backward compatible with Sphinx version 1.2, as it is the latest
version found on some distros like Debian.
All books currently support it.
Please notice that, while it mentions the eventual need of
XeLaTex and texlive to build pdf files, this is not a minimal
requirement, as one could just be interested on building html
documents. Also, identifying the minimal requirements for
texlive packages is not trivial, as each distribution seems to
use different criteria on grouping LaTex functionalities.
While here, update the current kernel version to 4.x.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
Documentation/development-process/Changes.rst | 36 ++++++++++++++++++++++++++-
1 file changed, 35 insertions(+), 1 deletion(-)
diff --git a/Documentation/development-process/Changes.rst b/Documentation/development-process/Changes.rst
index 97f7bf178340..754cd50c1bc6 100644
--- a/Documentation/development-process/Changes.rst
+++ b/Documentation/development-process/Changes.rst
@@ -7,7 +7,7 @@ Intro
=====
This document is designed to provide a list of the minimum levels of
-software necessary to run the 3.0 kernels.
+software necessary to run the 4.x kernels.
This document is originally based on my "Changes" file for 2.0.x kernels
and therefore owes credit to the same people as that file (Jared Mauch,
@@ -53,8 +53,10 @@ mcelog 0.6 mcelog --version
iptables 1.4.2 iptables -V
openssl & libcrypto 1.0.0 openssl version
bc 1.06.95 bc --version
+Sphinx\ [#f1]_ 1.2 sphinx-build --version
====================== =============== ========================================
+.. [#f1] Sphinx is needed only to build the Kernel documentation
Kernel compilation
******************
@@ -309,6 +311,30 @@ On x86 kernels the mcelog utility is needed to process and log machine check
events when ``CONFIG_X86_MCE`` is enabled. Machine check events are errors
reported by the CPU. Processing them is strongly encouraged.
+Kernel documentation
+********************
+
+Sphinx
+------
+
+The ReST markups currently used by the Documentation/ files are meant to be
+built with ``Sphinx`` version 1.2 or upper. If you're desiring to build
+PDF outputs, it is recommended to use version 1.4.6.
+
+.. note::
+
+ Please notice that, for PDF and LaTeX output, you'll also need ``XeLaTeX``
+ version 3.14159265. Depending on the distribution, you may also need
+ to install a series of ``texlive`` packages that provide the minimal
+ set of functionalities required for ``XeLaTex`` to work.
+
+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
========================
@@ -455,3 +481,11 @@ NFS-Utils
---------
- <http://nfs.sourceforge.net/>
+
+Kernel documentation
+********************
+
+Sphinx
+------
+
+- <http://www.sphinx-doc.org/>
--
2.7.4
next prev parent reply other threads:[~2016-09-14 23:09 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-09-14 23:05 [PATCH 00/17] Improve documentation for the development-process Mauro Carvalho Chehab
2016-09-14 23:05 ` [PATCH 01/17] HOWTO.rst: update information about generating documentation Mauro Carvalho Chehab
2016-09-14 23:05 ` [PATCH 02/17] HOWTO.rst: improve some markups to make it visually better Mauro Carvalho Chehab
2016-09-14 23:05 ` [PATCH 03/17] HOWTO.rst: adjust external link references Mauro Carvalho Chehab
2016-09-14 23:05 ` Mauro Carvalho Chehab [this message]
2016-09-14 23:05 ` [PATCH 05/17] SubmitChecklist: update kernel-doc task Mauro Carvalho Chehab
2016-09-14 23:05 ` [PATCH 06/17] SubmitChecklist: convert it to ReST markup Mauro Carvalho Chehab
2016-09-14 23:05 ` [PATCH 07/17] SubmitChecklist: rename to RST and add to the development-proccess book Mauro Carvalho Chehab
2016-09-16 8:11 ` Jean Delvare
2016-09-14 23:05 ` [PATCH 08/17] doc-rst: add CSS styles for :kbd: and :menuselection: Mauro Carvalho Chehab
2016-09-14 23:05 ` [PATCH 09/17] email-clients.txt: convert it to ReST markup Mauro Carvalho Chehab
2016-09-14 23:05 ` [PATCH 10/17] email-clients.txt: add it to the development-process book Mauro Carvalho Chehab
2016-09-14 23:05 ` [PATCH 11/17] SubmittingPatches.rst: Add some cross-references Mauro Carvalho Chehab
2016-09-14 23:05 ` [PATCH 12/17] SubmittingPatches.rst: enrich the Sphinx output Mauro Carvalho Chehab
2016-09-14 23:05 ` [PATCH 13/17] SubmittingDrivers.rst: add a cross reference to CodingStyle Mauro Carvalho Chehab
2016-09-14 23:05 ` [PATCH 14/17] stable_api_nonsense.rst: fix emphasis on Sphinx Mauro Carvalho Chehab
2016-09-14 23:06 ` [PATCH 15/17] ManagementStyle.rst: avoid emphasis where not desired Mauro Carvalho Chehab
2016-09-14 23:06 ` [PATCH 16/17] stable_kernel_rules.rst: Add cross-references to other ReST files Mauro Carvalho Chehab
2016-09-14 23:06 ` [PATCH 17/17] applying-patches.rst: Update the information there Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=38cce9fcfe7fea8f5da435f47a5f883f9e4b9306.1473893776.git.mchehab@s-opensource.com \
--to=mchehab@s-opensource.com \
--cc=David.Woodhouse@intel.com \
--cc=benoit.lemarchand@gmail.com \
--cc=corbet@lwn.net \
--cc=dhowells@redhat.com \
--cc=jani.nikula@linux.intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=markus.heiser@darmarit.de \
--cc=mchehab@infradead.org \
--cc=mchehab@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®