idr: fix kernel-doc warnings.

PATCH Applied Naohiro Aota 3 participants 8 messages Aug 30, 2010 – Aug 31, 2010

Subsystems (2)

Library code Xarray

lore

Share & tools

lore

Naohiro Aota

author

2010-08-30 15:43 UTC #0 lore raw

PATCH 1/2 idr: fix kernel-doc warnings.

Fix the following kernel-doc warnings.

% perl scripts/kernel-doc lib/idr.c > /dev/null
Warning(lib/idr.c:300): No description found for parameter 'starting_id' Warning(lib/idr.c:300): Excess function parameter 'start_id' description in 'idr_get_new_above' Warning(lib/idr.c:485): No description found for parameter 'idp' Warning(lib/idr.c:596): No description found for parameter 'nextidp' Warning(lib/idr.c:596): Excess function parameter 'id' description in 'idr_get_next' Warning(lib/idr.c:774): No description found for parameter 'starting_id' Warning(lib/idr.c:774): Excess function parameter 'staring_id' description in 'ida_get_new_above' Warning(lib/idr.c:918): No description found for parameter 'ida'

Signed-off-by Naohiro Aota <[email protected]>

---
 lib/idr.c |   10 +++++-----
 1 files changed, 5 insertions(+), 5 deletions(-)

lib/idr.c +5 -5

index 7f1a4f0..fb86a67 100644
@@ -284,7 +284,7 @@ static int idr_get_new_above_int(struct idr *idp, void *ptr, int starting_id)
  * idr_get_new_above - allocate new idr entry above or equal to a start id
  * @idp: idr handle
  * @ptr: pointer you want associated with the id
- * @start_id: id to start search at
+ * @starting_id: id to start search at
  * @id: pointer to the allocated handle
  *
  * This is the allocate id function.  It should be called with any

@@ -479,7 +479,7 @@ EXPORT_SYMBOL(idr_remove_all);
 
 /**
  * idr_destroy - release all cached layers within an idr tree
- * idp: idr handle
+ * @idp: idr handle
  */
 void idr_destroy(struct idr *idp)
 {

@@ -586,7 +586,7 @@ EXPORT_SYMBOL(idr_for_each);
 /**
  * idr_get_next - lookup next object of id to given id.
  * @idp: idr handle
- * @id:  pointer to lookup key
+ * @nextidp:  pointer to lookup key
  *
  * Returns pointer to registered object with id, which is next number to
  * given id.

@@ -758,7 +758,7 @@ EXPORT_SYMBOL(ida_pre_get);
 /**
  * ida_get_new_above - allocate new ID above or equal to a start id
  * @ida:	ida handle
- * @staring_id:	id to start search at
+ * @starting_id: id to start search at
  * @p_id:	pointer to the allocated handle
  *
  * Allocate new ID above or equal to @ida.  It should be called with

@@ -912,7 +912,7 @@ EXPORT_SYMBOL(ida_remove);
 
 /**
  * ida_destroy - release all cached layers within an ida tree
- * ida:		ida handle
+ * @ida:		ida handle
  */
 void ida_destroy(struct ida *ida)
 {

Signature · 1 line

1.7.2

Naohiro Aota

author

2010-08-30 15:46 UTC #1 lore raw

PATCH 2/2 idr: describe how nextidp works in idr_get_next().

It was unclear in original kernel-doc how nextidp worked in idr_get_next(). Let's describe it.

Signed-off-by Naohiro Aota <[email protected]>

---
 lib/idr.c |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

lib/idr.c +2 -1

index fb86a67..cf8c46b 100644
@@ -589,7 +589,8 @@ EXPORT_SYMBOL(idr_for_each);
  * @nextidp:  pointer to lookup key
  *
  * Returns pointer to registered object with id, which is next number to
- * given id.
+ * given id. The id pointed by nextidp will be updated
+ * appropriately for next iteration.
  */
 
 void *idr_get_next(struct idr *idp, int *nextidp)

Signature · 1 line

1.7.2

Tejun Heo

Acked-by on v1 1/2

2010-08-30 15:54 UTC #6 lore raw

In reply to Naohiro Aota

Quoted 12 lines · Naohiro Aota

Fix the following kernel-doc warnings.
% perl scripts/kernel-doc lib/idr.c > /dev/null
Warning(lib/idr.c:300): No description found for parameter 'starting_id' Warning(lib/idr.c:300): Excess function parameter 'start_id' description in 'idr_get_new_above' Warning(lib/idr.c:485): No description found for parameter 'idp' Warning(lib/idr.c:596): No description found for parameter 'nextidp' Warning(lib/idr.c:596): Excess function parameter 'id' description in 'idr_get_next' Warning(lib/idr.c:774): No description found for parameter 'starting_id' Warning(lib/idr.c:774): Excess function parameter 'staring_id' description in 'ida_get_new_above' Warning(lib/idr.c:918): No description found for parameter 'ida'

Quoted 1 line

Signed-off-by Naohiro Aota <[email protected]>

Acked-by Tejun Heo <[email protected]>

Thanks.

Signature · 1 line

tejun

Tejun Heo

2010-08-30 15:56 UTC #2 lore raw

Re: [PATCH 2/2] idr: describe how nextidp works in idr_get_next().

In reply to Naohiro Aota

Quoted 13 lines · Naohiro Aota

It was unclear in original kernel-doc how nextidp worked in idr_get_next(). Let's describe it.
Signed-off-by Naohiro Aota <[email protected]>
---
 lib/idr.c |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)
lib/idr.c +0 -0
index fb86a67..cf8c46b 100644

lib/idr.c EXPORT_SYMBOL(idr_for_each); · line 594

Quoted 7 lines

lib/idr.c +2 -1

@@ -589,7 +589,8 @@ EXPORT_SYMBOL(idr_for_each);
  * @nextidp:  pointer to lookup key
  *
  * Returns pointer to registered object with id, which is next number to
- * given id.
+ * given id. The id pointed by nextidp will be updated
+ * appropriately for next iteration.
  */

Maybe "After being looked up, *@nextidp will be updated for the next iteration" would be clearer?

Thanks.

Signature · 1 line

tejun

Naohiro Aota

author

2010-08-31 04:03 UTC #3 lore raw

Re: [PATCH 2/2] idr: describe how nextidp works in idr_get_next().

Quoted 9 lines · Tejun Heo

Quoted 8 lines · Naohiro Aota
It was unclear in original kernel-doc how nextidp worked in idr_get_next(). Let's describe it.
Signed-off-by Naohiro Aota <[email protected]>
---
 lib/idr.c |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

Quoted 15 lines

lib/idr.c EXPORT_SYMBOL(idr_for_each); · line 594
Quoted 12 lines
lib/idr.c +2 -1
index fb86a67..cf8c46b 100644
@@ -589,7 +589,8 @@ EXPORT_SYMBOL(idr_for_each);
  * @nextidp:  pointer to lookup key
  *
  * Returns pointer to registered object with id, which is next number to
- * given id.
+ * given id. The id pointed by nextidp will be updated
+ * appropriately for next iteration.
  */
Maybe "After being looked up, *@nextidp will be updated for the next iteration" would be clearer?

Thanks, the fixed patch below.

Quoted 1 line

From 6c61c97b5b85a350e3f195309b70a271457208ca Mon Sep 17 00:00:00 2001

From: Naohiro Aota <[email protected]>
Date: Fri, 27 Aug 2010 17:43:46 +0900
Subject: [PATCH 2/2] idr: describe how nextidp works in idr_get_next().

It was unclear in original kernel-doc how nextidp worked in idr_get_next(). Let's describe it.

Signed-off-by Naohiro Aota <[email protected]>

---
 lib/idr.c |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

lib/idr.c +2 -1

index fb86a67..5e0966b 100644
@@ -589,7 +589,8 @@ EXPORT_SYMBOL(idr_for_each);
  * @nextidp:  pointer to lookup key
  *
  * Returns pointer to registered object with id, which is next number to
- * given id.
+ * given id. After being looked up, *@nextidp will be updated for the next
+ * iteration.
  */
 
 void *idr_get_next(struct idr *idp, int *nextidp)

Signature · 1 line

1.7.2

Jiri Kosina

Applied

2010-08-31 07:32 UTC #7 lore raw

In reply to Tejun Heo

Quoted 10 lines · Tejun Heo

Quoted 10 lines
% perl scripts/kernel-doc lib/idr.c > /dev/null
Warning(lib/idr.c:300): No description found for parameter 'starting_id' Warning(lib/idr.c:300): Excess function parameter 'start_id' description in 'idr_get_new_above' Warning(lib/idr.c:485): No description found for parameter 'idp' Warning(lib/idr.c:596): No description found for parameter 'nextidp' Warning(lib/idr.c:596): Excess function parameter 'id' description in 'idr_get_next' Warning(lib/idr.c:774): No description found for parameter 'starting_id' Warning(lib/idr.c:774): Excess function parameter 'staring_id' description in 'ida_get_new_above' Warning(lib/idr.c:918): No description found for parameter 'ida'

Quoted 3 lines

Quoted 1 line
Signed-off-by Naohiro Aota <[email protected]>
Acked-by Tejun Heo <[email protected]>

Applied, thanks.

Signature · 2 lines

Jiri Kosina
SUSE Labs, Novell Inc.

Tejun Heo

Acked-by

2010-08-31 07:42 UTC #4 lore raw

Re: [PATCH 2/2] idr: describe how nextidp works in idr_get_next().

In reply to Naohiro Aota

Hello,

Quoted 9 lines · Naohiro Aota

Quoted 1 line
From 6c61c97b5b85a350e3f195309b70a271457208ca Mon Sep 17 00:00:00 2001
From: Naohiro Aota <[email protected]>
Date: Fri, 27 Aug 2010 17:43:46 +0900
Subject: [PATCH 2/2] idr: describe how nextidp works in idr_get_next().
It was unclear in original kernel-doc how nextidp worked in idr_get_next(). Let's describe it.
Signed-off-by Naohiro Aota <[email protected]>

Acked-by Tejun Heo <[email protected]>

Thanks.

Signature · 1 line

tejun

Jiri Kosina

Applied

2010-08-31 07:44 UTC #5 lore raw

Re: [PATCH 2/2] idr: describe how nextidp works in idr_get_next().

Quoted 10 lines · Tejun Heo

Quoted 8 lines
From: Naohiro Aota <[email protected]>
Date: Fri, 27 Aug 2010 17:43:46 +0900
Subject: [PATCH 2/2] idr: describe how nextidp works in idr_get_next().
It was unclear in original kernel-doc how nextidp worked in idr_get_next(). Let's describe it.
Signed-off-by Naohiro Aota <[email protected]>
Acked-by Tejun Heo <[email protected]>

Applied, thanks.

Signature · 2 lines

Jiri Kosina
SUSE Labs, Novell Inc.