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

[Naohiro Aota <naota@elisp.net>]

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