lkml.org 
[lkml]   [2013]   [Sep]   [8]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH] kernel-doc: Update script to find more "Return:" sections
On 09/03/2013 07:34:28 PM, Joe Perches wrote:
> Many kernel-doc return description sections headers
> use variants of the "Return:" section prefix.
>
> (some or maybe even most of these aren't in
> kernel-doc sections, but many are)
>
> $ git grep -E -i "^\s*\*\s*return[s]?:"| \
> cut -f2- -d":" | awk '{print $1 $2}' | \
> sort | uniq -c
> 121 *return:
> 838 *Return:
> 778 *RETURN:
> 191 *returns:
> 1965 *Returns:
> 603 *RETURNS:
>
> Rather than change all of the variants to the
> canonical "Return:", adapt the script to accept
> case insensitive "Return:" and "Returns:"
>
> Signed-off-by: Joe Perches <joe@perches.com>
> ---
>
> I don't know that this actually works.
> It does seem right though.
>
> Randy? Rob? Can you test this please?

I stopped reading this file at the line "#!/usr/bin/perl -w", but I'm
not sure if this is the right approach. Something that finds these and
lets us patch them to the cannonical version might be more appropriate.

Or are you going to add similar fuzzy matching for all the other
keywords?

Rob

\
 
 \ /
  Last update: 2013-09-09 03:21    [W:0.055 / U:0.008 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site