linux-imx

#!/usr/bin/env perl

# SPDX-License-Identifier: GPL-2.0

​

use warnings;

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/doc-guide/kernel-doc.rst for the documentation comment syntax.

​

Output format selection (mutually exclusive):

  -man          Output troff manual page format. This is the default.

  -rst          Output reStructuredText format.

  -none         Do not output documentation, only warnings.

​

Output selection (mutually exclusive):

  -export       Only output documentation for symbols that have been

            exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()

                        in any input FILE or -export-file FILE.

  -internal     Only output documentation for symbols that have NOT been

            exported using EXPORT_SYMBOL() or EXPORT_SYMBOL_GPL()

                        in any input FILE or -export-file 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.

  -nofunction NAME  Do NOT output documentation for the given function(s);

            only output documentation for the other functions and

            DOC: sections. May be specified multiple times.

​

Output selection modifiers:

  -no-doc-sections  Do not output DOC: sections.

  -enable-lineno        Enable output of #define LINENO lines. Only works with

                        reStructuredText format.

  -export-file FILE     Specify an additional FILE in which to look for

                        EXPORT_SYMBOL() and EXPORT_SYMBOL_GPL(). To be used with

                        -export or -internal. May be specified multiple times.

​

Other parameters:

  -v            Verbose output, more warnings and other information.

  -h            Print this help.

​

EOF

    print $message;

    exit 1;

}

​

#

# format of comments.

# In the following table, (...)? signifies optional structure.