From: Naohiro Aota <naota@elisp.net>
Date: Fri, 27 Aug 2010 08:43:46 +0000 (+0900)
Subject: idr: describe how nextidp works in idr_get_next().
X-Git-Url: http://drtracing.org/?a=commitdiff_plain;h=1458ce166c1b333ecbaf8caa9f4f54eab3a522a7;p=deliverable%2Flinux.git

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>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>
---

diff --git a/lib/idr.c b/lib/idr.c
index fb86a675dcff..5e0966be0f7c 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)