1. 30 Jun, 2018 1 commit
  2. 26 Jun, 2018 1 commit
  3. 15 Jun, 2018 1 commit
  4. 04 May, 2018 1 commit
  5. 09 Mar, 2018 1 commit
  6. 07 Mar, 2018 1 commit
  7. 17 Jan, 2018 1 commit
  8. 31 Aug, 2017 1 commit
  9. 23 Jul, 2017 1 commit
  10. 23 Jun, 2017 1 commit
  11. 16 May, 2017 1 commit
  12. 11 Apr, 2017 1 commit
  13. 31 Mar, 2017 1 commit
  14. 09 Mar, 2017 1 commit
    • Markus Heiser's avatar
      docs-rst: automatically convert Graphviz and SVG images · db6ccf23
      Markus Heiser authored
      This patch brings scalable figure, image handling and a concept to
      embed *render* markups:
      
      * DOT (http://www.graphviz.org)
      * SVG
      
      For image handling use the 'image' replacement::
      
          .. kernel-image::  svg_image.svg
             :alt:    simple SVG image
      
      For figure handling use the 'figure' replacement::
      
          .. kernel-figure::  svg_image.svg
             :alt:    simple SVG image
      
             SVG image example
      
      Embed *render* markups (or languages) like Graphviz's **DOT** is
      provided by the *render* directive.::
      
        .. kernel-render:: DOT
           :alt: foobar digraph
           :caption: Embedded **DOT** (Graphviz) code.
      
           digraph foo {
            "bar" -> "baz";
           }
      
      The *render* directive is a concept to integrate *render* markups and
      languages, yet supported markups:
      
      * DOT: render embedded Graphviz's **DOT**
      * SVG: render embedded Scalable Vector Graphics (**SVG**)
      
      Cc: Jani Nikula <jani.nikula@linux.intel.com>
      Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
      Tested-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
      Tested-by: Daniel Vetter's avatarDaniel Vetter <daniel.vetter@ffwll.ch>
      Signed-off-by: Daniel Vetter <daniel.vetter@intel.com> (v2 - v5)
      Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> (v1, v6)
      Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      db6ccf23
  15. 18 Dec, 2016 1 commit
  16. 01 Dec, 2016 1 commit
  17. 19 Nov, 2016 1 commit
  18. 19 Oct, 2016 1 commit
  19. 16 Sep, 2016 2 commits
  20. 09 Sep, 2016 2 commits
  21. 01 Sep, 2016 1 commit
  22. 22 Aug, 2016 3 commits
  23. 18 Aug, 2016 1 commit
  24. 14 Aug, 2016 1 commit
    • Markus Heiser's avatar
      doc-rst: generic way to build only sphinx sub-folders · 606b9ac8
      Markus Heiser authored
      Add a generic way to build only a reST sub-folder with or
      without a individual *build-theme*.
      
      * control *sub-folders* by environment SPHINXDIRS
      * control *build-theme* by environment SPHINX_CONF
      
      Folders with a conf.py file, matching $(srctree)/Documentation/*/conf.py
      can be build and distributed *stand-alone*. E.g. to compile only the
      html of 'media' and 'gpu' folder use::
      
        make SPHINXDIRS="media gpu" htmldocs
      
      To use an additional sphinx-build configuration (*build-theme*) set the
      name of the configuration file to SPHINX_CONF. E.g. to compile only the
      html of 'media' with the *nit-picking* build use::
      
        make SPHINXDIRS=media SPHINX_CONF=conf_nitpick.py htmldocs
      
      With this, the Documentation/conf.py is read first and updated with the
      configuration values from the Documentation/media/conf_nitpick.py.
      Signed-off-by: default avatarMarkus Heiser <markus.heiser@darmarIT.de>
      Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      606b9ac8
  25. 20 Jul, 2016 1 commit
  26. 09 Jul, 2016 1 commit
  27. 08 Jul, 2016 1 commit
    • 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
  28. 07 Jul, 2016 9 commits