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

From: Rob Landley
Date: Sun Sep 08 2013 - 21:05:59 EST


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@xxxxxxxxxxx>
---

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