Skip to content
Snippets Groups Projects
Select Git revision
  • ebff7f929b2a72fa614f5e95fd34c56c82ac9c36
  • vme-testing default
  • ci-test
  • master
  • remoteproc
  • am625-sk-ov5640
  • pcal6534-upstreaming
  • lps22df-upstreaming
  • msc-upstreaming
  • imx8mp
  • iio/noa1305
  • vme-next
  • vme-next-4.14-rc4
  • v4.14-rc4
  • v4.14-rc3
  • v4.14-rc2
  • v4.14-rc1
  • v4.13
  • vme-next-4.13-rc7
  • v4.13-rc7
  • v4.13-rc6
  • v4.13-rc5
  • v4.13-rc4
  • v4.13-rc3
  • v4.13-rc2
  • v4.13-rc1
  • v4.12
  • v4.12-rc7
  • v4.12-rc6
  • v4.12-rc5
  • v4.12-rc4
  • v4.12-rc3
32 results

kernel-doc

Blame
  • user avatar
    Daniel Vetter authored and Jani Nikula committed
    Further up in the state machinery we switch from STATE_NAME to
    STATE_DOCBLOCK when we match /$doc_block/. Which means this block of
    code here is entirely unreachable, unless there are multiple DOC:
    sections within a single kernel-doc comment.
    
    Getting a list of all the files with more than one DOC: section using
    
    $ git grep -c " * DOC:" | grep -v ":1$"
    
    and then doing a full audit of them reveals there are no such comment
    blocks in the kernel.
    
    Supporting multiple DOC: sections in a single kernel-doc comment does
    not seem like a recommended way of doing things anyway, so nuke the code
    for simplicity.
    
    Cc: Jani Nikula <jani.nikula@intel.com>
    Cc: linux-doc@vger.kernel.org
    Cc: Jonathan Corbet <corbet@lwn.net>
    Signed-off-by: default avatarDaniel Vetter <daniel.vetter@ffwll.ch>
    [Jani: amended the commit message]
    Signed-off-by: default avatarJani Nikula <jani.nikula@intel.com>
    ebff7f92
    History
    kernel-doc 85.06 KiB
    #!/usr/bin/perl -w
    
    use strict;
    
    ## Copyright (c) 1998 Michael Zucchi, All Rights Reserved        ##
    ## Copyright (C) 2000, 1  Tim Waugh <twaugh@redhat.com>          ##
    ## Copyright (C) 2001  Simon Huggins                             ##
    ## Copyright (C) 2005-2012  Randy Dunlap                         ##
    ## Copyright (C) 2012  Dan Luedtke                               ##
    ## 								 ##
    ## #define enhancements by Armin Kuster <akuster@mvista.com>	 ##
    ## Copyright (c) 2000 MontaVista Software, Inc.			 ##
    ## 								 ##
    ## This software falls under the GNU General Public License.     ##
    ## Please read the COPYING file for more information             ##
    
    # 18/01/2001 - 	Cleanups
    # 		Functions prototyped as foo(void) same as foo()
    # 		Stop eval'ing where we don't need to.
    # -- huggie@earth.li
    
    # 27/06/2001 -  Allowed whitespace after initial "/**" and
    #               allowed comments before function declarations.
    # -- Christian Kreibich <ck@whoop.org>
    
    # Still to do:
    # 	- add perldoc documentation
    # 	- Look more closely at some of the scarier bits :)
    
    # 26/05/2001 - 	Support for separate source and object trees.
    #		Return error code.
    # 		Keith Owens <kaos@ocs.com.au>
    
    # 23/09/2001 - Added support for typedefs, structs, enums and unions
    #              Support for Context section; can be terminated using empty line
    #              Small fixes (like spaces vs. \s in regex)
    # -- Tim Jansen <tim@tjansen.de>
    
    # 25/07/2012 - Added support for HTML5
    # -- Dan Luedtke <mail@danrl.de>
    
    sub usage {
        my $message = <<"EOF";
    Usage: $0 [OPTION ...] FILE ...
    
    Read C language source or header FILEs, extract embedded documentation comments,
    and print formatted documentation to standard output.
    
    The documentation comments are identified by "/**" opening comment mark. See
    Documentation/kernel-doc-nano-HOWTO.txt for the documentation comment syntax.
    
    Output format selection (mutually exclusive):
      -docbook		Output DocBook format.
      -html			Output HTML format.
      -html5		Output HTML5 format.
      -list			Output symbol list format. This is for use by docproc.
      -man			Output troff manual page format. This is the default.
      -rst			Output reStructuredText format.
      -text			Output plain text format.
    
    Output selection (mutually exclusive):
      -export		Only output documentation for symbols that have been
    			exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
    			in the same FILE.
      -internal		Only output documentation for symbols that have NOT been
    			exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()
    			in the same FILE.
      -function NAME	Only output documentation for the given function(s)
    			or DOC: section title(s). All other functions and DOC:
    			sections are ignored. May be specified multiple times.