lkml.org 
[lkml]   [2006]   [Oct]   [9]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
    Patch in this message
    /
    Date
    From
    Subject[PATCH] kernel-doc: make parameter description indentation uniform
    From: Randy Dunlap <rdunlap@xenotime.net>

    - In parameter descriptions, strip all whitespace between the parameter
    name (e.g., @len) and its description so that the description is
    indented uniformly in text and man page modes. Previously, spaces
    or tabs (which are used for cleaner source code viewing) affected
    the produced output in a negative way.

    Before (man mode):
    to Destination address, in user space.
    from Source address, in kernel space.
    n Number of bytes to copy.

    After (man mode):
    to Destination address, in user space.
    from Source address, in kernel space.
    n Number of bytes to copy.

    - Fix/clarify a few function description comments.

    Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
    ---
    scripts/kernel-doc | 12 +++++++-----
    1 files changed, 7 insertions(+), 5 deletions(-)

    --- linux-2619-rc1g3.orig/scripts/kernel-doc
    +++ linux-2619-rc1g3/scripts/kernel-doc
    @@ -1262,7 +1262,9 @@ sub output_intro_text(%) {
    }

    ##
    -# generic output function for typedefs
    +# generic output function for all types (function, struct/union, typedef, enum);
    +# calls the generated, variable output_ function name based on
    +# functype and output_mode
    sub output_declaration {
    no strict 'refs';
    my $name = shift;
    @@ -1278,8 +1280,7 @@ sub output_declaration {
    }

    ##
    -# generic output function - calls the right one based
    -# on current output mode.
    +# generic output function - calls the right one based on current output mode.
    sub output_intro {
    no strict 'refs';
    my $func = "output_intro_".$output_mode;
    @@ -1782,8 +1783,9 @@ sub process_file($) {
    $in_doc_sect = 1;
    $contents = $newcontents;
    if ($contents ne "") {
    - if (substr($contents, 0, 1) eq " ") {
    - $contents = substr($contents, 1);
    + while ((substr($contents, 0, 1) eq " ") ||
    + substr($contents, 0, 1) eq "\t") {
    + $contents = substr($contents, 1);
    }
    $contents .= "\n";
    }

    ---
    -
    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: 2006-10-09 07:05    [W:0.024 / U:0.936 seconds]
    ©2003-2016 Jasper Spaans. hosted at Digital OceanAdvertise on this site