lkml.org 
[lkml]   [2013]   [Sep]   [9]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
SubjectRe: [PATCH] kernel-doc: Update script to find more "Return:" sections
From
Date
On Sun, 2013-09-08 at 20:05 -0500, Rob Landley wrote:
> 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.

~3500 different lines to patch is a lot.

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

What other keywords are there that are not freeform?

The only other style I know of is @arg:



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