[PATCH] net: description of dma_cookie cause make xmldocs warning

[PATCH] net: description of dma_cookie cause make xmldocs warning

[Masanari Iida]

In commit 7bced397510ab569d31de4c70b39e13355046387,
dma_cookie was removed from struct skbuff.
But the description of dma_cookie still exist.
So the "make xmldocs" output following warning.

Warning(.//include/linux/skbuff.h:609): Excess struct/union
/enum/typedef member 'dma_cookie' description in 'sk_buff'

Remove description of dma_cookie fix the symptom.

Signed-off-by: Masanari Iida <standby24x7@gmail.com>
---
 include/linux/skbuff.h | 2 --
 1 file changed, 2 deletions(-)

diff --git a/include/linux/skbuff.h b/include/linux/skbuff.h
index a17ba08..9a86644 100644
--- a/include/linux/skbuff.h
+++ b/include/linux/skbuff.h
@@ -459,8 +459,6 @@ static inline u32 skb_mstamp_us_delta(const struct skb_mstamp *t1,
  *	@wifi_acked_valid: wifi_acked was set
  *	@wifi_acked: whether frame was acked on wifi or not
  *	@no_fcs:  Request NIC to treat last 4 bytes as Ethernet FCS
- *	@dma_cookie: a cookie to one of several possible DMA operations
- *		done by skb DMA functions
   *	@napi_id: id of the NAPI struct this skb came from
  *	@secmark: security marking
  *	@mark: Generic packet mark
-- 
2.1.1.273.g97b8860

Re: [PATCH] net: description of dma_cookie cause make xmldocs warning

[Dan Williams]

On Wed, Oct 8, 2014 at 7:53 AM, Masanari Iida <standby24x7@gmail.com> wrote:
> In commit 7bced397510ab569d31de4c70b39e13355046387,
> dma_cookie was removed from struct skbuff.
> But the description of dma_cookie still exist.
> So the "make xmldocs" output following warning.
>
> Warning(.//include/linux/skbuff.h:609): Excess struct/union
> /enum/typedef member 'dma_cookie' description in 'sk_buff'
>
> Remove description of dma_cookie fix the symptom.
>
> Signed-off-by: Masanari Iida <standby24x7@gmail.com>

Acked-by: Dan Williams <dan.j.williams@intel.com>

Re: [PATCH] net: description of dma_cookie cause make xmldocs warning

[Sergei Shtylyov]

Hello.

On 10/08/2014 06:53 PM, Masanari Iida wrote:

> In commit 7bced397510ab569d31de4c70b39e13355046387,

    Please also specify that commit's summary line in parens.

> dma_cookie was removed from struct skbuff.
> But the description of dma_cookie still exist.
> So the "make xmldocs" output following warning.

> Warning(.//include/linux/skbuff.h:609): Excess struct/union
> /enum/typedef member 'dma_cookie' description in 'sk_buff'

> Remove description of dma_cookie fix the symptom.

> Signed-off-by: Masanari Iida <standby24x7@gmail.com>

WBR, Sergei

Re: [PATCH] net: description of dma_cookie cause make xmldocs warning

[Eric Dumazet]

On Wed, 2014-10-08 at 19:59 +0400, Sergei Shtylyov wrote:
> Hello.
> 
> On 10/08/2014 06:53 PM, Masanari Iida wrote:
> 
> > In commit 7bced397510ab569d31de4c70b39e13355046387,
> 
>     Please also specify that commit's summary line in parens.

Note that this information is useful for backports and bug fixes.

In this particular case (documentation), there is no chance we'll
backport this patch to any prior stable kernel

Re: [PATCH] net: description of dma_cookie cause make xmldocs warning

[David Miller]

From: Masanari Iida <standby24x7@gmail.com>
Date: Wed,  8 Oct 2014 23:53:39 +0900

> In commit 7bced397510ab569d31de4c70b39e13355046387,
> dma_cookie was removed from struct skbuff.
> But the description of dma_cookie still exist.
> So the "make xmldocs" output following warning.
> 
> Warning(.//include/linux/skbuff.h:609): Excess struct/union
> /enum/typedef member 'dma_cookie' description in 'sk_buff'
> 
> Remove description of dma_cookie fix the symptom.
> 
> Signed-off-by: Masanari Iida <standby24x7@gmail.com>

Applied.