[PATCH] kernel-doc: restrict syntax for private: and public:

[PATCH] kernel-doc: restrict syntax for private: and public:

[Randy Dunlap]

From: Randy Dunlap <randy.dunlap@oracle.com>

scripts/kernel-doc can (incorrectly) delete struct members that
are surrounded by /* ... */ <struct members> /* ... */
if there is a /* private: */ comment in there somewhere also.

Fix that by making the "/* private:" only allow whitespace
between /* and "private:", not anything/everything in the world.

This fixes some erroneous kernel-doc warnings that popped up
while processing include/linux/usb/composite.h.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
---
 Documentation/kernel-doc-nano-HOWTO.txt |    7 +++++--
 scripts/kernel-doc                      |    7 ++++---
 2 files changed, 9 insertions(+), 5 deletions(-)

--- linux-2.6.30-rc3-git4.orig/scripts/kernel-doc
+++ linux-2.6.30-rc3-git4/scripts/kernel-doc
@@ -1411,7 +1411,8 @@ sub dump_struct($$) {
     my $file = shift;
     my $nested;
 
-    if ($x =~/(struct|union)\s+(\w+)\s*{(.*)}/) {
+    if ($x =~ /(struct|union)\s+(\w+)\s*{(.*)}/) {
+	#my $decl_type = $1;
 	$declaration_name = $2;
 	my $members = $3;
 
@@ -1420,8 +1421,8 @@ sub dump_struct($$) {
 	$nested = $1;
 
 	# ignore members marked private:
-	$members =~ s/\/\*.*?private:.*?public:.*?\*\///gos;
-	$members =~ s/\/\*.*?private:.*//gos;
+	$members =~ s/\/\*\s*private:.*?\/\*\s*public:.*?\*\///gos;
+	$members =~ s/\/\*\s*private:.*//gos;
 	# strip comments:
 	$members =~ s/\/\*.*?\*\///gos;
 	$nested =~ s/\/\*.*?\*\///gos;
--- linux-2.6.30-rc3-git4.orig/Documentation/kernel-doc-nano-HOWTO.txt
+++ linux-2.6.30-rc3-git4/Documentation/kernel-doc-nano-HOWTO.txt
@@ -269,7 +269,10 @@ Use the argument mechanism to document m
 
 Inside a struct description, you can use the "private:" and "public:"
 comment tags.  Structure fields that are inside a "private:" area
-are not listed in the generated output documentation.
+are not listed in the generated output documentation.  The "private:"
+and "public:" tags must begin immediately following a "/*" comment
+marker.  They may optionally include comments between the ":" and the
+ending "*/" marker.
 
 Example:
 
@@ -283,7 +286,7 @@ Example:
 struct my_struct {
     int a;
     int b;
-/* private: */
+/* private: internal use only */
     int c;
 };
 

Re: [PATCH] kernel-doc: restrict syntax for private: and public:

[Sam Ravnborg]

On Tue, Apr 28, 2009 at 03:17:57PM -0700, Randy Dunlap wrote:
> From: Randy Dunlap <randy.dunlap@oracle.com>
> 
> scripts/kernel-doc can (incorrectly) delete struct members that
> are surrounded by /* ... */ <struct members> /* ... */
> if there is a /* private: */ comment in there somewhere also.
> 
> Fix that by making the "/* private:" only allow whitespace
> between /* and "private:", not anything/everything in the world.
> 
> This fixes some erroneous kernel-doc warnings that popped up
> while processing include/linux/usb/composite.h.

Applied to kbuild-next.

	Sam