treewide: fix kernel-doc warnings

PATCH Applied Vitaliy Ivanov 5 participants 5 messages Jun 27, 2011 – Jun 28, 2011

Subsystems (4)

Networking Driver core Sockets High-resolution timers, timer wheel, clockevents

lore

Share & tools

lore

Vitaliy Ivanov

author

2011-06-27 16:35 UTC #0 lore raw

PATCH 1/1 treewide: fix kernel-doc warnings

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.

---

Quoted 1 line

From 55fe3701d1ed1f1302a73cd5bfdfc7972e89f5b7 Mon Sep 17 00:00:00 2001

From: Vitaliy Ivanov <[email protected]>
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 <[email protected]>

---
 include/linux/device.h  |    1 -
 include/linux/hrtimer.h |    1 +
 include/net/sock.h      |    1 -
 3 files changed, 1 insertions(+), 2 deletions(-)

include/linux/device.h +0 -1

index 553fd37..e4f62d8 100644
@@ -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.

include/linux/hrtimer.h +1 -0

index 51932e5..fd0dc30 100644
@@ -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

include/net/sock.h +0 -1

index f2046e4..c0b938c 100644
@@ -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

Signature · 1 line

1.7.0.4

Grant Likely

Acked-by on v1 1/1

2011-06-27 16:54 UTC #1 lore raw

Quoted 40 lines · Vitaliy Ivanov

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.
---
Quoted 1 line
From 55fe3701d1ed1f1302a73cd5bfdfc7972e89f5b7 Mon Sep 17 00:00:00 2001
From: Vitaliy Ivanov <[email protected]>
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 <[email protected]>
---
include/linux/device.h | 1 -
include/linux/hrtimer.h | 1 +
include/net/sock.h | 1 -
 3 files changed, 1 insertions(+), 2 deletions(-)
include/linux/device.h +0 -0
index 553fd37..e4f62d8 100644

include/linux/device.h struct device_dma_parameters { · line 535

Quoted 7 lines

include/linux/device.h +0 -1

@@ -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 <[email protected]>

Quoted 30 lines

include/linux/hrtimer.h +1 -0

index 51932e5..fd0dc30 100644
@@ -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

include/net/sock.h +0 -2

index f2046e4..c0b938c 100644
@@ -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

Signature · 2 lines

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

David Miller

maintainer Acked-by on v1 1/1

2011-06-27 23:05 UTC #2 lore raw

In reply to Vitaliy Ivanov

From: Vitaliy Ivanov <[email protected]>
Date: Mon, 27 Jun 2011 19:33:46 +0300

Quoted 7 lines

Quoted 1 line
From 55fe3701d1ed1f1302a73cd5bfdfc7972e89f5b7 Mon Sep 17 00:00:00 2001
From: Vitaliy Ivanov <[email protected]>
Date: Mon, 27 Jun 2011 19:07:08 +0300
Subject: [PATCH] treewide: fix kernel-doc warnings
Fix 'make htmldocs' warnings:

Quoted 8 lines

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 <[email protected]>

Acked-by David S. Miller <[email protected]>

Jiri Kosina

Applied

2011-06-28 08:51 UTC #3 lore raw

Quoted 14 lines · David Miller

Quoted 14 lines
Quoted 1 line
From 55fe3701d1ed1f1302a73cd5bfdfc7972e89f5b7 Mon Sep 17 00:00:00 2001
From: Vitaliy Ivanov <[email protected]>
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'

Quoted 3 lines

Quoted 1 line
Signed-off-by Vitaliy Ivanov <[email protected]>
Acked-by David S. Miller <[email protected]>

Applied, thanks.

Signature · 2 lines

Jiri Kosina
SUSE Labs

Randy Dunlap

Acked-by on v1 1/1

2011-06-27 23:12 UTC #4 lore raw

In reply to Vitaliy Ivanov

Quoted 6 lines · 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'

Quoted 6 lines

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 <[email protected]>

Thanks.

Quoted 52 lines

---
Quoted 1 line
From 55fe3701d1ed1f1302a73cd5bfdfc7972e89f5b7 Mon Sep 17 00:00:00 2001
From: Vitaliy Ivanov <[email protected]>
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 <[email protected]>
---
 include/linux/device.h  |    1 -
 include/linux/hrtimer.h |    1 +
 include/net/sock.h      |    1 -
 3 files changed, 1 insertions(+), 2 deletions(-)
include/linux/device.h +0 -1
index 553fd37..e4f62d8 100644
@@ -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.
include/linux/hrtimer.h +1 -0
index 51932e5..fd0dc30 100644
@@ -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
include/net/sock.h +0 -0
index f2046e4..c0b938c 100644

include/net/sock.h struct sock_common { · line 183

Quoted 7 lines

include/net/sock.h +0 -1

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