Patchwork [4/6] net/sock.h: make some fields private to fix kernel-doc warning(s)

login
register
mail settings
Submitter Randy Dunlap
Date Jan. 9, 2011, 3:39 a.m.
Message ID <20110108193921.e03ca09e.randy.dunlap@oracle.com>
Download mbox | patch
Permalink /patch/78002/
State Accepted
Delegated to: David Miller
Headers show

Comments

Randy Dunlap - Jan. 9, 2011, 3:39 a.m.
From: Randy Dunlap <randy.dunlap@oracle.com>

Fix new kernel-doc notation warning in sock.h by annotating skc_dontcopy_*
as private fields.

Warning(include/net/sock.h:163): No description found for parameter 'skc_dontcopy_end[0]'

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
---
 include/net/sock.h |    4 ++++
 1 file changed, 4 insertions(+)

--
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
David Miller - Jan. 10, 2011, 12:27 a.m.
From: Randy Dunlap <randy.dunlap@oracle.com>
Date: Sat, 8 Jan 2011 19:39:21 -0800

> From: Randy Dunlap <randy.dunlap@oracle.com>
> 
> Fix new kernel-doc notation warning in sock.h by annotating skc_dontcopy_*
> as private fields.
> 
> Warning(include/net/sock.h:163): No description found for parameter 'skc_dontcopy_end[0]'
> 
> Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>

Applied.
--
To unsubscribe from this list: send the line "unsubscribe netdev" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch

--- lnx0107.orig/include/net/sock.h
+++ lnx0107/include/net/sock.h
@@ -152,14 +152,18 @@  struct sock_common {
 	 * fields between dontcopy_begin/dontcopy_end
 	 * are not copied in sock_copy()
 	 */
+	/* private: */
 	int			skc_dontcopy_begin[0];
+	/* public: */
 	union {
 		struct hlist_node	skc_node;
 		struct hlist_nulls_node skc_nulls_node;
 	};
 	int			skc_tx_queue_mapping;
 	atomic_t		skc_refcnt;
+	/* private: */
 	int                     skc_dontcopy_end[0];
+	/* public: */
 };
 
 /**