linux-kernel - [PATCH v2] scripts/kernel-doc: handle struct member _

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

Message-Id: <1361725787-18470-1-git-send-email-nm@ti.com>
Date:	Sun, 24 Feb 2013 11:09:47 -0600
From:	Nishanth Menon <nm@...com>
To:	Randy Dunlap <rdunlap@...radead.org>
Cc:	Nishanth Menon <nm@...com>, Fengguang Wu <fengguang.wu@...el.com>,
	Johannes Berg <johannes.berg@...el.com>,
	Andrew Morton <akpm@...ux-foundation.org>,
	linux-kernel@...r.kernel.org (open list)
Subject: [PATCH v2] scripts/kernel-doc: handle struct member __aligned without numbers

commit ef5da59f12602815baa8fad98241b77dedea3b31
(scripts/kernel-doc: handle struct member __aligned)
char something [123] __aligned(8);

However, by using \d we constraint ourselves with integers.
This is not always the case. In fact, it might be better to do
char something[123] __aligned(sizeof(u16));

For example, With wireless_dev defining:
u8 address[ETH_ALEN] __aligned(sizeof(u16));
With \d, scripts/kernel-doc erroneously says:
Warning(include/net/cfg80211.h:2618): Excess struct/union/enum/typedef member 'address' description in 'wireless_dev'
This is because the regex __aligned\s*\(\d+\) fails match at \d as
sizeof is used.

So replace \d with . to indicate "something" in kernel-doc
to ignore __aligned(SOMETHING) in structs. With this change,
we can use integers OR sizeof() or macros as we please.

Cc: Fengguang Wu <fengguang.wu@...el.com>
Cc: Johannes Berg <johannes.berg@...el.com>
Cc: Andrew Morton <akpm@...ux-foundation.org>
Cc: Randy Dunlap <rdunlap@...radead.org>
Cc: linux-kernel@...r.kernel.org (open list)

Signed-off-by: Nishanth Menon <nm@...com>

---
Based on 
master              9e2d59a Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/viro/signal

Rev1: I have seen Johannes' patch here:
http://permalink.gmane.org/gmane.linux.documentation/9271

Rev 2: instead of using prm_clean, we use members which Randy had tried to cleanup

We already have an holder to cleanup aligned, why add another, so just fix it.

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

diff --git a/scripts/kernel-doc b/scripts/kernel-doc
index f565536..4305b2f 100755
--- a/scripts/kernel-doc
+++ b/scripts/kernel-doc
@@ -1750,7 +1750,7 @@ sub dump_struct($$) {
 	# strip kmemcheck_bitfield_{begin,end}.*;
 	$members =~ s/kmemcheck_bitfield_.*?;//gos;
 	# strip attributes
-	$members =~ s/__aligned\s*\(\d+\)//gos;
+	$members =~ s/__aligned\s*\(.+\)//gos;
 
 	create_parameterlist($members, ';', $file);
 	check_sections($file, $declaration_name, "struct", $sectcheck, $struct_actual, $nested);
-- 
1.7.9.5

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