mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Joe Perches <joe@perches.com>
To: Rob Landley <rob@landley.net>
Cc: Randy Dunlap <rdunlap@infradead.org>,
	Andrew Morton <akpm@linux-foundation.org>,
	LKML <linux-kernel@vger.kernel.org>,
	linux-doc@vger.kernel.org
Subject: Re: [PATCH] kernel-doc: Update script to find more "Return:" sections
Date: Sun, 08 Sep 2013 21:01:40 -0700	[thread overview]
Message-ID: <1378699300.1928.1.camel@joe-AO722> (raw)
In-Reply-To: <1378688750.8385.5@driftwood>

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:


      reply	other threads:[~2013-09-09  4:11 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-09-04  0:34 Joe Perches
2013-09-05 18:20 ` Randy Dunlap
2013-09-09  1:05 ` Rob Landley
2013-09-09  4:01   ` Joe Perches [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1378699300.1928.1.camel@joe-AO722 \
    --to=joe@perches.com \
    --cc=akpm@linux-foundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=rob@landley.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®