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

[Naohiro Aota]

Tejun Heo <tj@xxxxxxxxxx> 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@xxxxxxxxx>
>> ---
>>  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.

==