lkml.org 
[lkml]   [2007]   [Oct]   [24]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    Date
    From
    Subject[PATCH 4/6] kernel-doc: process functions, not DOC:
    From: Johannes Berg <johannes@sipsolutions.net>

    This flag is necessary for the next patch for docproc to output
    only the functions and not DOC: sections when a function list
    is requested.

    Signed-off-by: Johannes Berg <johannes@sipsolutions.net>
    Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>

    ---
    scripts/kernel-doc | 14 ++++++++++++--
    1 file changed, 12 insertions(+), 2 deletions(-)

    --- linux-2.6.23-git19.orig/scripts/kernel-doc
    +++ linux-2.6.23-git19/scripts/kernel-doc
    @@ -46,13 +46,16 @@ use strict;
    # Note: This only supports 'c'.

    # usage:
    -# kernel-doc [ -docbook | -html | -text | -man ]
    +# kernel-doc [ -docbook | -html | -text | -man ] [ -no-doc-sections ]
    # [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile
    # or
    # [ -nofunction funcname [ -function funcname ...] ] c file(s)s > outputfile
    #
    # Set output format using one of -docbook -html -text or -man. Default is man.
    #
    +# -no-doc-sections
    +# Do not output DOC: sections
    +#
    # -function funcname
    # If set, then only generate documentation for the given function(s) or
    # DOC: section titles. All other functions and DOC: sections are ignored.
    @@ -211,7 +214,7 @@ my $blankline_text = "";


    sub usage {
    - print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man ]\n";
    + print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man ] [ -no-doc-sections ]\n";
    print " [ -function funcname [ -function funcname ...] ]\n";
    print " [ -nofunction funcname [ -nofunction funcname ...] ]\n";
    print " c source file(s) > outputfile\n";
    @@ -225,6 +228,7 @@ if ($#ARGV==-1) {

    my $verbose = 0;
    my $output_mode = "man";
    +my $no_doc_sections = 0;
    my %highlights = %highlights_man;
    my $blankline = $blankline_man;
    my $modulename = "Kernel API";
    @@ -329,6 +333,8 @@ while ($ARGV[0] =~ m/^-(.*)/) {
    usage();
    } elsif ($cmd eq '-filelist') {
    $filelist = shift @ARGV;
    + } elsif ($cmd eq '-no-doc-sections') {
    + $no_doc_sections = 1;
    }
    }

    @@ -380,6 +386,10 @@ sub dump_doc_section {
    my $name = shift;
    my $contents = join "\n", @_;

    + if ($no_doc_sections) {
    + return;
    + }
    +
    if (($function_only==0) ||
    ( $function_only == 1 && defined($function_table{$name})) ||
    ( $function_only == 2 && !defined($function_table{$name})))

    --

    -
    To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
    the body of a message to majordomo@vger.kernel.org
    More majordomo info at http://vger.kernel.org/majordomo-info.html
    Please read the FAQ at http://www.tux.org/lkml/

    \
     
     \ /
      Last update: 2007-10-25 00:17    [W:0.023 / U:38.476 seconds]
    ©2003-2017 Jasper Spaans. hosted at Digital OceanAdvertise on this site