linux-kernel - Re: [PATCH] kernel-doc: Update script to find more "Return:" sections

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:	Sun, 08 Sep 2013 21:01:40 -0700
From:	Joe Perches <joe@...ches.com>
To:	Rob Landley <rob@...dley.net>
Cc:	Randy Dunlap <rdunlap@...radead.org>,
	Andrew Morton <akpm@...ux-foundation.org>,
	LKML <linux-kernel@...r.kernel.org>, linux-doc@...r.kernel.org
Subject: Re: [PATCH] kernel-doc: Update script to find more "Return:"
 sections

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@...ches.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:

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