• Markus Heiser's avatar
    doc-rst: add kernel-include directive · 03776378
    Markus Heiser authored
    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: default avatarMarkus Heiser <markus.heiser@darmarIT.de>
    Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
    03776378
kernel_include.py 8.23 KB