mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
* [PATCH] treewide: fix kernel-doc warnings
@ 2011-06-27 16:33 Vitaliy Ivanov
  2011-06-27 16:54 ` Grant Likely
                   ` (2 more replies)
  0 siblings, 3 replies; 5+ messages in thread
From: Vitaliy Ivanov @ 2011-06-27 16:33 UTC (permalink / raw)
  To: LKML, Linus Torvalds, Jiri Kosina
  Cc: vitalivanov, Grant Likely, David S. Miller, Eric Dumazet,
	Thomas Gleixner

Fixing 'make htmldocs' warnings:

Warning(/include/linux/hrtimer.h:153): No description found for parameter 'clockid'
Warning(/include/linux/device.h:604): Excess struct/union/enum/typedef member 'of_match' description in 'device'
Warning(/include/net/sock.h:349): Excess struct/union/enum/typedef member 'sk_rmem_alloc' description in 'sock'

Issue with:
Warning(/include/net/wimax.h:432): No description found for parameter 'rfkill_input'
is already solved in net-next tree -
commit #c6af9c406ceb3434281cf230938453931dcbab75 - net: wimax: Remove of unused 'rfkill_input' pointer.

Patch is against latest Linus' tree.

---
>From 55fe3701d1ed1f1302a73cd5bfdfc7972e89f5b7 Mon Sep 17 00:00:00 2001
From: Vitaliy Ivanov <vitalivanov@gmail.com>
Date: Mon, 27 Jun 2011 19:07:08 +0300
Subject: [PATCH] treewide: fix kernel-doc warnings

Fix 'make htmldocs' warnings:

Warning(/include/linux/hrtimer.h:153): No description found for
parameter 'clockid'
Warning(/include/linux/device.h:604): Excess struct/union/enum/typedef
member 'of_match' description in 'device'
Warning(/include/net/sock.h:349): Excess struct/union/enum/typedef
member 'sk_rmem_alloc' description in 'sock'

Signed-off-by: Vitaliy Ivanov <vitalivanov@gmail.com>
---
 include/linux/device.h  |    1 -
 include/linux/hrtimer.h |    1 +
 include/net/sock.h      |    1 -
 3 files changed, 1 insertions(+), 2 deletions(-)

diff --git a/include/linux/device.h b/include/linux/device.h
index 553fd37..e4f62d8 100644
--- a/include/linux/device.h
+++ b/include/linux/device.h
@@ -530,7 +530,6 @@ struct device_dma_parameters {
  * @dma_mem:	Internal for coherent mem override.
  * @archdata:	For arch-specific additions.
  * @of_node:	Associated device tree node.
- * @of_match:	Matching of_device_id from driver.
  * @devt:	For creating the sysfs "dev".
  * @devres_lock: Spinlock to protect the resource of the device.
  * @devres_head: The resources list of the device.
diff --git a/include/linux/hrtimer.h b/include/linux/hrtimer.h
index 51932e5..fd0dc30 100644
--- a/include/linux/hrtimer.h
+++ b/include/linux/hrtimer.h
@@ -135,6 +135,7 @@ struct hrtimer_sleeper {
  * @cpu_base:		per cpu clock base
  * @index:		clock type index for per_cpu support when moving a
  *			timer to a base on another cpu.
+ * @clockid:		clock id for per_cpu support
  * @active:		red black tree root node for the active timers
  * @resolution:		the resolution of the clock, in nanoseconds
  * @get_time:		function to retrieve the current time of the clock
diff --git a/include/net/sock.h b/include/net/sock.h
index f2046e4..c0b938c 100644
--- a/include/net/sock.h
+++ b/include/net/sock.h
@@ -178,7 +178,6 @@ struct sock_common {
   *	@sk_dst_cache: destination cache
   *	@sk_dst_lock: destination cache lock
   *	@sk_policy: flow policy
-  *	@sk_rmem_alloc: receive queue bytes committed
   *	@sk_receive_queue: incoming packets
   *	@sk_wmem_alloc: transmit queue bytes committed
   *	@sk_write_queue: Packet sending queue
-- 
1.7.0.4




^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] treewide: fix kernel-doc warnings
  2011-06-27 16:33 [PATCH] treewide: fix kernel-doc warnings Vitaliy Ivanov
@ 2011-06-27 16:54 ` Grant Likely
  2011-06-27 23:00 ` David Miller
  2011-06-27 23:10 ` Randy Dunlap
  2 siblings, 0 replies; 5+ messages in thread
From: Grant Likely @ 2011-06-27 16:54 UTC (permalink / raw)
  To: Vitaliy Ivanov
  Cc: LKML, Linus Torvalds, Jiri Kosina, David S. Miller, Eric Dumazet,
	Thomas Gleixner

On Mon, Jun 27, 2011 at 10:33 AM, Vitaliy Ivanov <vitalivanov@gmail.com> wrote:
> Fixing 'make htmldocs' warnings:
>
> Warning(/include/linux/hrtimer.h:153): No description found for parameter 'clockid'
> Warning(/include/linux/device.h:604): Excess struct/union/enum/typedef member 'of_match' description in 'device'
> Warning(/include/net/sock.h:349): Excess struct/union/enum/typedef member 'sk_rmem_alloc' description in 'sock'
>
> Issue with:
> Warning(/include/net/wimax.h:432): No description found for parameter 'rfkill_input'
> is already solved in net-next tree -
> commit #c6af9c406ceb3434281cf230938453931dcbab75 - net: wimax: Remove of unused 'rfkill_input' pointer.
>
> Patch is against latest Linus' tree.
>
> ---
> >From 55fe3701d1ed1f1302a73cd5bfdfc7972e89f5b7 Mon Sep 17 00:00:00 2001
> From: Vitaliy Ivanov <vitalivanov@gmail.com>
> Date: Mon, 27 Jun 2011 19:07:08 +0300
> Subject: [PATCH] treewide: fix kernel-doc warnings
>
> Fix 'make htmldocs' warnings:
>
> Warning(/include/linux/hrtimer.h:153): No description found for
> parameter 'clockid'
> Warning(/include/linux/device.h:604): Excess struct/union/enum/typedef
> member 'of_match' description in 'device'
> Warning(/include/net/sock.h:349): Excess struct/union/enum/typedef
> member 'sk_rmem_alloc' description in 'sock'
>
> Signed-off-by: Vitaliy Ivanov <vitalivanov@gmail.com>
> ---
>  include/linux/device.h  |    1 -
>  include/linux/hrtimer.h |    1 +
>  include/net/sock.h      |    1 -
>  3 files changed, 1 insertions(+), 2 deletions(-)
>
> diff --git a/include/linux/device.h b/include/linux/device.h
> index 553fd37..e4f62d8 100644
> --- a/include/linux/device.h
> +++ b/include/linux/device.h
> @@ -530,7 +530,6 @@ struct device_dma_parameters {
>  * @dma_mem:   Internal for coherent mem override.
>  * @archdata:  For arch-specific additions.
>  * @of_node:   Associated device tree node.
> - * @of_match:  Matching of_device_id from driver.
>  * @devt:      For creating the sysfs "dev".
>  * @devres_lock: Spinlock to protect the resource of the device.
>  * @devres_head: The resources list of the device.

Acked-by: Grant Likely <grant.likely@secretlab.ca>

> diff --git a/include/linux/hrtimer.h b/include/linux/hrtimer.h
> index 51932e5..fd0dc30 100644
> --- a/include/linux/hrtimer.h
> +++ b/include/linux/hrtimer.h
> @@ -135,6 +135,7 @@ struct hrtimer_sleeper {
>  * @cpu_base:          per cpu clock base
>  * @index:             clock type index for per_cpu support when moving a
>  *                     timer to a base on another cpu.
> + * @clockid:           clock id for per_cpu support
>  * @active:            red black tree root node for the active timers
>  * @resolution:                the resolution of the clock, in nanoseconds
>  * @get_time:          function to retrieve the current time of the clock
> diff --git a/include/net/sock.h b/include/net/sock.h
> index f2046e4..c0b938c 100644
> --- a/include/net/sock.h
> +++ b/include/net/sock.h
> @@ -178,7 +178,6 @@ struct sock_common {
>   *    @sk_dst_cache: destination cache
>   *    @sk_dst_lock: destination cache lock
>   *    @sk_policy: flow policy
> -  *    @sk_rmem_alloc: receive queue bytes committed
>   *    @sk_receive_queue: incoming packets
>   *    @sk_wmem_alloc: transmit queue bytes committed
>   *    @sk_write_queue: Packet sending queue
> --
> 1.7.0.4
>
>
>
>



-- 
Grant Likely, B.Sc., P.Eng.
Secret Lab Technologies Ltd.

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] treewide: fix kernel-doc warnings
  2011-06-27 16:33 [PATCH] treewide: fix kernel-doc warnings Vitaliy Ivanov
  2011-06-27 16:54 ` Grant Likely
@ 2011-06-27 23:00 ` David Miller
  2011-06-28  8:49   ` Jiri Kosina
  2011-06-27 23:10 ` Randy Dunlap
  2 siblings, 1 reply; 5+ messages in thread
From: David Miller @ 2011-06-27 23:00 UTC (permalink / raw)
  To: vitalivanov
  Cc: linux-kernel, torvalds, jkosina, grant.likely, eric.dumazet, tglx

From: Vitaliy Ivanov <vitalivanov@gmail.com>
Date: Mon, 27 Jun 2011 19:33:46 +0300

>>From 55fe3701d1ed1f1302a73cd5bfdfc7972e89f5b7 Mon Sep 17 00:00:00 2001
> From: Vitaliy Ivanov <vitalivanov@gmail.com>
> Date: Mon, 27 Jun 2011 19:07:08 +0300
> Subject: [PATCH] treewide: fix kernel-doc warnings
> 
> Fix 'make htmldocs' warnings:
> 
> Warning(/include/linux/hrtimer.h:153): No description found for
> parameter 'clockid'
> Warning(/include/linux/device.h:604): Excess struct/union/enum/typedef
> member 'of_match' description in 'device'
> Warning(/include/net/sock.h:349): Excess struct/union/enum/typedef
> member 'sk_rmem_alloc' description in 'sock'
> 
> Signed-off-by: Vitaliy Ivanov <vitalivanov@gmail.com>

Acked-by: David S. Miller <davem@davemloft.net>

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] treewide: fix kernel-doc warnings
  2011-06-27 16:33 [PATCH] treewide: fix kernel-doc warnings Vitaliy Ivanov
  2011-06-27 16:54 ` Grant Likely
  2011-06-27 23:00 ` David Miller
@ 2011-06-27 23:10 ` Randy Dunlap
  2 siblings, 0 replies; 5+ messages in thread
From: Randy Dunlap @ 2011-06-27 23:10 UTC (permalink / raw)
  To: Vitaliy Ivanov
  Cc: LKML, Linus Torvalds, Jiri Kosina, Grant Likely, David S. Miller,
	Eric Dumazet, Thomas Gleixner

On Mon, 27 Jun 2011 19:33:46 +0300 Vitaliy Ivanov wrote:

> Fixing 'make htmldocs' warnings:
> 
> Warning(/include/linux/hrtimer.h:153): No description found for parameter 'clockid'
> Warning(/include/linux/device.h:604): Excess struct/union/enum/typedef member 'of_match' description in 'device'
> Warning(/include/net/sock.h:349): Excess struct/union/enum/typedef member 'sk_rmem_alloc' description in 'sock'
> 
> Issue with:
> Warning(/include/net/wimax.h:432): No description found for parameter 'rfkill_input'
> is already solved in net-next tree -
> commit #c6af9c406ceb3434281cf230938453931dcbab75 - net: wimax: Remove of unused 'rfkill_input' pointer.
> 
> Patch is against latest Linus' tree.

Acked-by: Randy Dunlap <rdunlap@xenotime.net>

Thanks.

> ---
> >From 55fe3701d1ed1f1302a73cd5bfdfc7972e89f5b7 Mon Sep 17 00:00:00 2001
> From: Vitaliy Ivanov <vitalivanov@gmail.com>
> Date: Mon, 27 Jun 2011 19:07:08 +0300
> Subject: [PATCH] treewide: fix kernel-doc warnings
> 
> Fix 'make htmldocs' warnings:
> 
> Warning(/include/linux/hrtimer.h:153): No description found for
> parameter 'clockid'
> Warning(/include/linux/device.h:604): Excess struct/union/enum/typedef
> member 'of_match' description in 'device'
> Warning(/include/net/sock.h:349): Excess struct/union/enum/typedef
> member 'sk_rmem_alloc' description in 'sock'
> 
> Signed-off-by: Vitaliy Ivanov <vitalivanov@gmail.com>
> ---
>  include/linux/device.h  |    1 -
>  include/linux/hrtimer.h |    1 +
>  include/net/sock.h      |    1 -
>  3 files changed, 1 insertions(+), 2 deletions(-)
> 
> diff --git a/include/linux/device.h b/include/linux/device.h
> index 553fd37..e4f62d8 100644
> --- a/include/linux/device.h
> +++ b/include/linux/device.h
> @@ -530,7 +530,6 @@ struct device_dma_parameters {
>   * @dma_mem:	Internal for coherent mem override.
>   * @archdata:	For arch-specific additions.
>   * @of_node:	Associated device tree node.
> - * @of_match:	Matching of_device_id from driver.
>   * @devt:	For creating the sysfs "dev".
>   * @devres_lock: Spinlock to protect the resource of the device.
>   * @devres_head: The resources list of the device.
> diff --git a/include/linux/hrtimer.h b/include/linux/hrtimer.h
> index 51932e5..fd0dc30 100644
> --- a/include/linux/hrtimer.h
> +++ b/include/linux/hrtimer.h
> @@ -135,6 +135,7 @@ struct hrtimer_sleeper {
>   * @cpu_base:		per cpu clock base
>   * @index:		clock type index for per_cpu support when moving a
>   *			timer to a base on another cpu.
> + * @clockid:		clock id for per_cpu support
>   * @active:		red black tree root node for the active timers
>   * @resolution:		the resolution of the clock, in nanoseconds
>   * @get_time:		function to retrieve the current time of the clock
> diff --git a/include/net/sock.h b/include/net/sock.h
> index f2046e4..c0b938c 100644
> --- a/include/net/sock.h
> +++ b/include/net/sock.h
> @@ -178,7 +178,6 @@ struct sock_common {
>    *	@sk_dst_cache: destination cache
>    *	@sk_dst_lock: destination cache lock
>    *	@sk_policy: flow policy
> -  *	@sk_rmem_alloc: receive queue bytes committed
>    *	@sk_receive_queue: incoming packets
>    *	@sk_wmem_alloc: transmit queue bytes committed
>    *	@sk_write_queue: Packet sending queue
> -- 

---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***

^ permalink raw reply	[flat|nested] 5+ messages in thread

* Re: [PATCH] treewide: fix kernel-doc warnings
  2011-06-27 23:00 ` David Miller
@ 2011-06-28  8:49   ` Jiri Kosina
  0 siblings, 0 replies; 5+ messages in thread
From: Jiri Kosina @ 2011-06-28  8:49 UTC (permalink / raw)
  To: David Miller
  Cc: vitalivanov, linux-kernel, torvalds, grant.likely, eric.dumazet, tglx

On Mon, 27 Jun 2011, David Miller wrote:

> >>From 55fe3701d1ed1f1302a73cd5bfdfc7972e89f5b7 Mon Sep 17 00:00:00 2001
> > From: Vitaliy Ivanov <vitalivanov@gmail.com>
> > Date: Mon, 27 Jun 2011 19:07:08 +0300
> > Subject: [PATCH] treewide: fix kernel-doc warnings
> > 
> > Fix 'make htmldocs' warnings:
> > 
> > Warning(/include/linux/hrtimer.h:153): No description found for
> > parameter 'clockid'
> > Warning(/include/linux/device.h:604): Excess struct/union/enum/typedef
> > member 'of_match' description in 'device'
> > Warning(/include/net/sock.h:349): Excess struct/union/enum/typedef
> > member 'sk_rmem_alloc' description in 'sock'
> > 
> > Signed-off-by: Vitaliy Ivanov <vitalivanov@gmail.com>
> 
> Acked-by: David S. Miller <davem@davemloft.net>

Applied, thanks.

-- 
Jiri Kosina
SUSE Labs

^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2011-06-28  8:51 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2011-06-27 16:33 [PATCH] treewide: fix kernel-doc warnings Vitaliy Ivanov
2011-06-27 16:54 ` Grant Likely
2011-06-27 23:00 ` David Miller
2011-06-28  8:49   ` Jiri Kosina
2011-06-27 23:10 ` Randy Dunlap

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®