diff mbox

[-next] skbuff.h: fix timestamps kernel-doc

Message ID 20090227104638.5b4f8f6e.randy.dunlap@oracle.com
State Accepted, archived
Delegated to: David Miller
Headers show

Commit Message

Randy Dunlap Feb. 27, 2009, 6:46 p.m. UTC 
From: Randy Dunlap <randy.dunlap@oracle.com>

Fix skbuff.h kernel-doc for timestamps: must include "struct" keyword,
otherwise there are kernel-doc errors:

Error(linux-next-20090227//include/linux/skbuff.h:161): cannot understand prototype: 'struct skb_shared_hwtstamps '
Error(linux-next-20090227//include/linux/skbuff.h:177): cannot understand prototype: 'union skb_shared_tx '

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

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

Comments

David Miller March 2, 2009, 11:16 a.m. UTC | #1 
From: Randy Dunlap <randy.dunlap@oracle.com>
Date: Fri, 27 Feb 2009 10:46:38 -0800

> From: Randy Dunlap <randy.dunlap@oracle.com>
> 
> Fix skbuff.h kernel-doc for timestamps: must include "struct" keyword,
> otherwise there are kernel-doc errors:
> 
> Error(linux-next-20090227//include/linux/skbuff.h:161): cannot understand prototype: 'struct skb_shared_hwtstamps '
> Error(linux-next-20090227//include/linux/skbuff.h:177): cannot understand prototype: 'union skb_shared_tx '
> 
> Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>

Applied, thanks Randy.
--
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
diff mbox

Patch

--- linux-next-20090227.orig/include/linux/skbuff.h
+++ linux-next-20090227/include/linux/skbuff.h
@@ -135,8 +135,7 @@  struct skb_frag_struct {
 #define HAVE_HW_TIME_STAMP
 
 /**
- * skb_shared_hwtstamps - hardware time stamps
- *
+ * struct skb_shared_hwtstamps - hardware time stamps
  * @hwtstamp:	hardware time stamp transformed into duration
  *		since arbitrary point in time
  * @syststamp:	hwtstamp transformed to system time base
@@ -164,8 +163,7 @@  struct skb_shared_hwtstamps {
 };
 
 /**
- * skb_shared_tx - instructions for time stamping of outgoing packets
- *
+ * struct skb_shared_tx - instructions for time stamping of outgoing packets
  * @hardware:		generate hardware time stamp
  * @software:		generate software time stamp
  * @in_progress:	device driver is going to provide