1. 20 Jul, 2016 1 commit
  2. 14 Jul, 2015 1 commit
  3. 28 May, 2013 1 commit
  4. 06 Dec, 2012 1 commit
    • Yacine Belkadi's avatar
      Kernel-doc: Convention: Use a "Return" section to describe return values · ddf5eabd
      Yacine Belkadi authored
      Non-void functions should describe their return values in their kernel-doc
      comments. Currently, some don't, others do in various forms. For example:
         * Return the result.
         * Return: The result.
         * Returns the result.
         * Returns: the result.
         * Return Value: The result.
         * @return: the result.
         * This function returns the result.
         * It will return the result.
      
      Defining a convention would improve consistency of kernel-doc comments. It
      would also help scripts/kernel-doc identify the text describing the return
      value of a function. Thus allowing additional checks on the comments, and
      suitable highlighting in the generated docs (man pages, html, etc).
      
      So, as a convention, use a section named "Return" to describe the return
      value of a function.
      Signed-off-by: default avatarYacine Belkadi <yacine.belkadi.1@gmail.com>
      Acked-by: default avatarRandy Dunlap <rdunlap@infradead.org>
      Signed-off-by: default avatarMichal Marek <mmarek@suse.cz>
      ddf5eabd
  5. 27 Nov, 2012 1 commit
    • Yacine Belkadi's avatar
      Kernel-doc: Convention: Use a "Return" section to describe return values · e65fe5a9
      Yacine Belkadi authored
      Non-void functions should describe their return values in their kernel-doc
      comments. Currently, some don't, others do in various forms. For example:
         * Return the result.
         * Return: The result.
         * Returns the result.
         * Returns: the result.
         * Return Value: The result.
         * @return: the result.
         * This function returns the result.
         * It will return the result.
      
      Defining a convention would improve consistency of kernel-doc comments. It
      would also help scripts/kernel-doc identify the text describing the return
      value of a function. Thus allowing additional checks on the comments, and
      suitable highlighting in the generated docs (man pages, html, etc).
      
      So, as a convention, use a section named "Return" to describe the return
      value of a function.
      Signed-off-by: default avatarYacine Belkadi <yacine.belkadi.1@gmail.com>
      Signed-off-by: default avatarRob Landley <rob@landley.net>
      Signed-off-by: default avatarJiri Kosina <jkosina@suse.cz>
      e65fe5a9
  6. 11 Sep, 2010 1 commit
  7. 11 Jan, 2010 1 commit
  8. 18 Sep, 2009 1 commit
  9. 02 May, 2009 1 commit
  10. 11 Feb, 2009 1 commit
  11. 06 Jan, 2009 2 commits
  12. 26 Aug, 2008 1 commit
  13. 06 Jun, 2008 1 commit
    • Paul Jackson's avatar
      doc: document the kernel-doc conventions for kernel hackers · 0842b245
      Paul Jackson authored
      Provide documentation of the kernel-doc documentation conventions oriented
      to kernel hackers.
      
      Since I figure that there will be more people reading this
      kernel-doc-nano-HOWTO.txt file who are kernel developers focused on the
      rest of the kernel, than there will be readers of this file who are
      documentation developers extracting that embedded kernel-doc
      documentation, I have taken the liberty of making the new section added
      here:
      
        How to format kernel-doc comments
      
      the first section of the kernel-doc-nano-HOWTO.txt file.
      
      This first section is intended to introduce, motivate and provide basic
      usage of the kernel-doc mechanism for kernel hackers developing other
      portions of the kernel.
      Signed-off-by: default avatarPaul Jackson <pj@sgi.com>
      Acked-by: default avatarRandy Dunlap <rdunlap@xenotime.net>
      Cc: Alan Cox <alan@lxorguk.ukuu.org.uk>
      Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
      Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
      0842b245
  14. 11 Feb, 2007 2 commits
  15. 03 Nov, 2006 1 commit
  16. 01 Feb, 2006 1 commit
  17. 16 Apr, 2005 1 commit
    • Linus Torvalds's avatar
      Linux-2.6.12-rc2 · 1da177e4
      Linus Torvalds authored
      Initial git repository build. I'm not bothering with the full history,
      even though we have it. We can create a separate "historical" git
      archive of that later if we want to, and in the meantime it's about
      3.2GB when imported into git - space that would just make the early
      git days unnecessarily complicated, when we don't have a lot of good
      infrastructure for it.
      
      Let it rip!
      1da177e4