linux/Documentation/sphinx
Markus Heiser 037763785a doc-rst: add kernel-include directive
The kernel-include directive is needed to include the auto generated rst
content from a build (pre-) process. E.g. the linux_tv Makefile
generates intermediate reST-files from header files. Since there is a O=
option:

  make O=dir [targets] Locate all output files in "dir"

We need to include intermediate reST files from arbitrary (O=/tmp/foo)
locations:

The 'kernel-include' reST-directive is a replacement for the 'include'
directive. The 'kernel-include' directive expand environment variables
in the path name and allows to include files from arbitrary locations.

.. hint::

  Including files from arbitrary locations (e.g. from '/etc') is a
  security risk for builders. This is why the 'include' directive from
  docutils *prohibit* pathnames pointing to locations *above* the
  filesystem tree where the reST document with the include directive is
  placed.

Substrings of the form $name or ${name} are replaced by the value of
environment variable name. Malformed variable names and references to
non-existing variables are left unchanged.

Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-08 09:31:04 -03:00
..
convert_template.sed Documentation/sphinx: nicer referencing of struct in docbook->rst conversion 2016-05-30 13:38:54 +03:00
kernel_include.py doc-rst: add kernel-include directive 2016-07-08 09:31:04 -03:00
kernel-doc.py Documentation/sphinx: add support for specifying extra export files 2016-06-10 16:46:55 +03:00
parse-headers.pl doc-rst: parse-headers: don't do substituition references 2016-07-07 15:13:17 -03:00
post_convert.sed Documentation/sphinx: nicer referencing of struct in docbook->rst conversion 2016-05-30 13:38:54 +03:00
rstFlatTable.py doc-rst: flat-table directive - initial implementation 2016-06-30 12:58:33 -06:00
tmplcvt