[PATCH] idr: fix new kernel-doc warnings

[PATCH] idr: fix new kernel-doc warnings

[Randy Dunlap]

From: Randy Dunlap <rdunlap@infradead.org>

Fix new kernel-doc warnings in idr:

Warning(include/linux/idr.h:113): No description found for parameter 'idr'
Warning(include/linux/idr.h:113): Excess function parameter 'idp' description in 'idr_find'
Warning(lib/idr.c:232): Excess function parameter 'id' description in 'sub_alloc'
Warning(lib/idr.c:232): Excess function parameter 'id' description in 'sub_alloc'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc:	Tejun Heo <tj@kernel.org>
---
 include/linux/idr.h |    2 +-
 lib/idr.c           |    1 -
 2 files changed, 1 insertion(+), 2 deletions(-)

--- lnx-39-rc1.orig/include/linux/idr.h
+++ lnx-39-rc1/include/linux/idr.h
@@ -99,7 +99,7 @@ static inline void idr_preload_end(void)
 
 /**
  * idr_find - return pointer for given id
- * @idp: idr handle
+ * @idr: idr handle
  * @id: lookup key
  *
  * Return the pointer given the id it has been registered with.  A %NULL
--- lnx-39-rc1.orig/lib/idr.c
+++ lnx-39-rc1/lib/idr.c
@@ -214,7 +214,6 @@ EXPORT_SYMBOL(idr_pre_get);
  * sub_alloc - try to allocate an id without growing the tree depth
  * @idp: idr handle
  * @starting_id: id to start search at
- * @id: pointer to the allocated handle
  * @pa: idr_layer[MAX_IDR_LEVEL] used as backtrack buffer
  * @gfp_mask: allocation mask for idr_layer_alloc()
  * @layer_idr: optional idr passed to idr_layer_alloc()

Re: [PATCH] idr: fix new kernel-doc warnings

[Tejun Heo]

On Mon, Mar 4, 2013 at 2:32 PM, Randy Dunlap <rdunlap@infradead.org> wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
>
> Fix new kernel-doc warnings in idr:
>
> Warning(include/linux/idr.h:113): No description found for parameter 'idr'
> Warning(include/linux/idr.h:113): Excess function parameter 'idp' description in 'idr_find'
> Warning(lib/idr.c:232): Excess function parameter 'id' description in 'sub_alloc'
> Warning(lib/idr.c:232): Excess function parameter 'id' description in 'sub_alloc'
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc:     Tejun Heo <tj@kernel.org>

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

Thanks!

-- 
tejun