1
0
Fork 0
alistair23-linux/Documentation/sphinx
Markus Heiser b62b9d81a0 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>
2016-09-01 08:19:02 -06:00
..
cdomain.py doc-rst: moved *duplicate* warnings to nitpicky mode 2016-08-22 15:19:38 -06:00
convert_template.sed Documentation/sphinx: nicer referencing of struct in docbook->rst conversion 2016-05-30 13:38:54 +03:00
kernel-doc.py docs: sphinx-extensions: add metadata parallel-safe 2016-09-01 08:19:02 -06:00
kernel_include.py docs: sphinx-extensions: add metadata parallel-safe 2016-09-01 08:19:02 -06:00
load_config.py doc-rst: generic way to build only sphinx sub-folders 2016-08-14 11:51:51 -06:00
parse-headers.pl docs-rst: parse-heraders.pl: escape LaTeX characters 2016-08-18 16:42:07 -06:00
post_convert.sed Documentation/sphinx: nicer referencing of struct in docbook->rst conversion 2016-05-30 13:38:54 +03:00
rstFlatTable.py docs: sphinx-extensions: add metadata parallel-safe 2016-09-01 08:19:02 -06:00
tmplcvt sphinx: cheesy script to convert .tmpl files 2016-05-30 13:38:53 +03:00