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

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

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

Signed-off-by: Naohiro Aota <naota@elisp.net>
---
 lib/idr.c |   10 +++++-----
 1 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/lib/idr.c b/lib/idr.c
index 7f1a4f0..fb86a67 100644
--- a/lib/idr.c
+++ b/lib/idr.c
@@ -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)
 {
-- 
1.7.2

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

[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 <naota@elisp.net>
---
 lib/idr.c |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

diff --git a/lib/idr.c b/lib/idr.c
index fb86a67..cf8c46b 100644
--- a/lib/idr.c
+++ b/lib/idr.c
@@ -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)
-- 
1.7.2

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

[Tejun Heo]

On 08/30/2010 05:39 PM, Naohiro Aota wrote:
> It was unclear in original kernel-doc how nextidp worked in
> idr_get_next(). Let's describe it.
> 
> Signed-off-by: Naohiro Aota <naota@elisp.net>
> ---
>  lib/idr.c |    3 ++-
>  1 files changed, 2 insertions(+), 1 deletions(-)
> 
> diff --git a/lib/idr.c b/lib/idr.c
> index fb86a67..cf8c46b 100644
> --- a/lib/idr.c
> +++ b/lib/idr.c
> @@ -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.

-- 
tejun

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

[Naohiro Aota]

Tejun Heo <tj@kernel.org> writes:

> On 08/30/2010 05:39 PM, Naohiro Aota wrote:
>> It was unclear in original kernel-doc how nextidp worked in
>> idr_get_next(). Let's describe it.
>> 
>> Signed-off-by: Naohiro Aota <naota@elisp.net>
>> ---
>>  lib/idr.c |    3 ++-
>>  1 files changed, 2 insertions(+), 1 deletions(-)
>> 
>> diff --git a/lib/idr.c b/lib/idr.c
>> index fb86a67..cf8c46b 100644
>> --- a/lib/idr.c
>> +++ b/lib/idr.c
>> @@ -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.

==
>From 6c61c97b5b85a350e3f195309b70a271457208ca Mon Sep 17 00:00:00 2001
From: Naohiro Aota <naota@elisp.net>
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 <naota@elisp.net>
---
 lib/idr.c |    3 ++-
 1 files changed, 2 insertions(+), 1 deletions(-)

diff --git a/lib/idr.c b/lib/idr.c
index fb86a67..5e0966b 100644
--- a/lib/idr.c
+++ b/lib/idr.c
@@ -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)
-- 
1.7.2

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

[Tejun Heo]

Hello,

On 08/31/2010 06:02 AM, Naohiro Aota wrote:
>>From 6c61c97b5b85a350e3f195309b70a271457208ca Mon Sep 17 00:00:00 2001
> From: Naohiro Aota <naota@elisp.net>
> 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 <naota@elisp.net>

Acked-by: Tejun Heo <tj@kernel.org>

Thanks.

-- 
tejun

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

[Jiri Kosina]

On Tue, 31 Aug 2010, Tejun Heo wrote:

> > From: Naohiro Aota <naota@elisp.net>
> > 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 <naota@elisp.net>
> 
> Acked-by: Tejun Heo <tj@kernel.org>

Applied, thanks.

-- 
Jiri Kosina
SUSE Labs, Novell Inc.

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

[Tejun Heo]

On 08/30/2010 05:37 PM, Naohiro Aota wrote:
> 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 <naota@elisp.net>

Acked-by: Tejun Heo <tj@kernel.org>

Thanks.

-- 
tejun

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

[Jiri Kosina]

On Mon, 30 Aug 2010, Tejun Heo wrote:

> > % 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 <naota@elisp.net>
> 
> Acked-by: Tejun Heo <tj@kernel.org>

Applied, thanks.

-- 
Jiri Kosina
SUSE Labs, Novell Inc.