linux-kernel - [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-next>] [day] [month] [year] [list]

Message-ID: <1378254868.7347.40.camel@joe-AO722>
Date:	Tue, 03 Sep 2013 17:34:28 -0700
From:	Joe Perches <joe@...ches.com>
To:	Randy Dunlap <rdunlap@...radead.org>,
	Rob Landley <rob@...dley.net>,
	Andrew Morton <akpm@...ux-foundation.org>
Cc:	LKML <linux-kernel@...r.kernel.org>, linux-doc@...r.kernel.org
Subject: [PATCH] kernel-doc: Update script to find more "Return:" sections

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?

 scripts/kernel-doc | 1 +
 1 file changed, 1 insertion(+)

diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index 4305b2f..2b96411 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -418,6 +418,7 @@ sub dump_section {
 	$parameterdescs{$name} = $contents;
 	$sectcheck = $sectcheck . $name . " ";
     } else {
+	$name = "Return" if $name =~ /^return[s]?$/i;
 #	print STDERR "other section '$name' = '$contents'\n";
 	if (defined($sections{$name}) && ($sections{$name} ne "")) {
 		print STDERR "Error(${file}:$.): duplicate section name '$name'\n";


--
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/