1. 04 May, 2018 1 commit
  2. 23 Feb, 2018 1 commit
  3. 18 Feb, 2018 4 commits
  4. 13 Feb, 2018 5 commits
    • Matthew Wilcox's avatar
      Restructure kernel-doc.rst · 46347502
      Matthew Wilcox authored
      I found the layout confusing with multiple introductions to what
      kernel-doc is and how to use it.
      
      I made the following changes:
       - Moved the 'Including kernel-doc comments' section to the end of
         the document -- we should explain what it *is* before we explain
         how to integrate it.
       - Moved the 'Recommendations' subsection to the top.  We want people
         to know what to document before telling them how to do it.
       - Rewrite the 'Writing kernel-doc comments' section, integrating
         the 'Recommendations' subsection and a paragraph from 'How to format
         kernel-doc comments'.
       - Remove the paragraph about the kernel-doc script; we're supposed to
         be teaching people how to use punctuation to write pretty documentation,
         not documenting the build tooling.
       - Split the 'Parameters and member arguments' section into 'Function
         parameters' and 'Members'.  Structure members are not commonly
         referred to as arguments.
       - Integrate the 'private:' and 'public:' tag descriptions into the
         'Members' section.
       - Move the 'In-line member documentation comments' subsection up to be
         with the 'Members' section.
      Signed-off-by: default avatarMatthew Wilcox <mawilcox@microsoft.com>
      Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      46347502
    • Matthew Wilcox's avatar
      Fix whitespace in example · 9831e554
      Matthew Wilcox authored
      Line up the second line in the way that the example purports to be
      showing.
      Signed-off-by: default avatarMatthew Wilcox <mawilcox@microsoft.com>
      Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      9831e554
    • Matthew Wilcox's avatar
      Add scripts/split-man.pl · 5b229fbe
      Matthew Wilcox authored
      Instead of asking the user to copy and paste a small perl script from
      the documentation, just distribute the perl script in the scripts
      directory.
      Signed-off-by: default avatarMatthew Wilcox <mawilcox@microsoft.com>
      Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      5b229fbe
    • Matthew Wilcox's avatar
      Minor fixes to kernel-doc.rst · dcb50d97
      Matthew Wilcox authored
      The author clearly meant to use the word 'which' here.  Also replace
      some tabs with spaces which fixes the syntax highlighting in my editor.
      Signed-off-by: default avatarMatthew Wilcox <mawilcox@microsoft.com>
      Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      dcb50d97
    • Matthew Wilcox's avatar
      Add documentation for Context section · da70b8c4
      Matthew Wilcox authored
      This section is mentioned in scripts/kernel-doc, so we should mention it
      in doc-guide/kernel-doc.rst.  There are close to 500 comments using the
      Context section already, and almost 300 using a Locking section which
      fulfills much the same purpose (and should probably be converted for
      consistency).
      Signed-off-by: default avatarMatthew Wilcox <mawilcox@microsoft.com>
      Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      da70b8c4
  5. 21 Dec, 2017 7 commits
  6. 19 Oct, 2017 1 commit
  7. 26 Aug, 2017 1 commit
  8. 23 Jul, 2017 1 commit
  9. 17 Jul, 2017 5 commits
  10. 16 May, 2017 3 commits
  11. 09 Mar, 2017 2 commits
    • 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: default 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
    • Daniel Vetter's avatar
      doc: Explain light-handed markup preference a bit better · c3c53600
      Daniel Vetter authored
      We're still pretty far away from anything like a consensus, but
      there's clearly a lot of people who prefer an as-light as possible
      approach to converting existing .txt files to .rst. Make sure this is
      properly taken into account and clear.
      
      Motivated by discussions with Peter and Christoph and others.
      
      Cc: Christoph Hellwig <hch@infradead.org>
      Cc: Peter Zijlstra <peterz@infradead.org>
      Cc: Jani Nikula <jani.nikula@linux.intel.com>
      Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>
      Signed-off-by: default avatarDaniel Vetter <daniel.vetter@intel.com>
      Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
      c3c53600
  12. 01 Dec, 2016 1 commit
  13. 19 Nov, 2016 3 commits