Skip to contentSkip to conversation

idr: fix new kernel-doc warnings

PATCH In review Randy Dunlap 2 participants 2 messages Mar 4, 2013

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 idr: fix new kernel-doc warnings

From: Randy Dunlap <[email protected]>

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'

---
 include/linux/idr.h |    2 +-
 lib/idr.c           |    1 -
 2 files changed, 1 insertion(+), 2 deletions(-)
include/linux/idr.h +1 -1
@@ -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
lib/idr.c +0 -1
@@ -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()
Acked-by on v1 1/1
#1 lore raw
Quoted 11 lines · Randy Dunlap

From: Randy Dunlap <[email protected]>

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'

Thanks!

Signature · 1 line
tejun