docs: sphinx-extensions: add metadata parallel-safe
authorMarkus Heiser <markus.heiser@darmarIT.de>
Wed, 24 Aug 2016 13:35:24 +0000 (15:35 +0200)
committerJonathan Corbet <corbet@lwn.net>
Thu, 1 Sep 2016 14:19:02 +0000 (08:19 -0600)
commitb62b9d81a06f60ae4ad5f7a9c969f5b9680e2829
tree07e63a98dcee6c93c88d70be40d8321ff005f217
parent82801d065b4915d030e7f63212d146a75042aa91
docs: sphinx-extensions: add metadata parallel-safe

The setup() function of a Sphinx-extension can return a dictionary. This
is treated by Sphinx as metadata of the extension [1].

With metadata "parallel_read_safe = True" a extension is marked as
save for "parallel reading of source". This is needed if you want
build in parallel with N processes. E.g.:

  make SPHINXOPTS=-j4 htmldocs

will no longer log warnings like:

  WARNING: the foobar extension does not declare if it is safe for
  parallel reading, assuming it isn't - please ask the extension author
  to check and make it explicit.

Add metadata to extensions:

* kernel-doc
* flat-table
* kernel-include

[1] http://www.sphinx-doc.org/en/stable/extdev/#extension-metadata

Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
Tested-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Documentation/sphinx/kernel-doc.py
Documentation/sphinx/kernel_include.py
Documentation/sphinx/rstFlatTable.py [changed mode: 0644->0755]