Commit c95c2d32 authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds
Browse files

lib: remove "expecting prototype" kernel-doc warnings 

Fix various kernel-doc warnings in lib/ due to missing or erroneous
function names.

Add kernel-doc for some function parameters that was missing.  Use
kernel-doc "Return:" notation in earlycpio.c.

Quietens the following warnings:

  lib/earlycpio.c:61: warning: expecting prototype for cpio_data find_cpio_data(). Prototype was for find_cpio_data() instead

  lib/lru_cache.c:640: warning: expecting prototype for lc_dump(). Prototype was for lc_seq_dump_details() instead
  lru_cache.c:90: warning: Function parameter or member 'cache' not described in 'lc_create'

  lib/parman.c:368: warning: expecting prototype for parman_item_del(). Prototype was for parman_item_remove() instead
  parman.c:309: warning: Excess function parameter 'prority' description in 'parman_prio_init'

  lib/radix-tree.c:703: warning: expecting prototype for __radix_tree_insert(). Prototype was for radix_tree_insert() instead
  radix-tree.c:180: warning: Excess function parameter 'addr' description in 'radix_tree_find_next_bit'
  radix-tree.c:180: warning: Excess function parameter 'size' description in 'radix_tree_find_next_bit'
  radix-tree.c:931: warning: Function parameter or member 'iter' not described in 'radix_tree_iter_replace'

Link: https://lkml.kernel.org/r/20210411221756.15461-1-rdunlap@infradead.org


Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Cc: Philipp Reisner <philipp.reisner@linbit.com>
Cc: Lars Ellenberg <lars.ellenberg@linbit.com>
Cc: Jiri Pirko <jiri@nvidia.com>
Cc: Matthew Wilcox <willy@infradead.org>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 04c53de5

lib/earlycpio.c

+2 −2
Original line number Diff line number Diff line
@@ -40,7 +40,7 @@ enum cpio_fields { 
};



/**

 * cpio_data find_cpio_data - Search for files in an uncompressed cpio

 * find_cpio_data - Search for files in an uncompressed cpio

 * @path:       The directory to search for, including a slash at the end

 * @data:       Pointer to the cpio archive or a header inside

 * @len:        Remaining length of the cpio based on data pointer
@@ -49,7 +49,7 @@ enum cpio_fields { 
 *              matching file itself. It can be used to iterate through the cpio

 *              to find all files inside of a directory path.

 *

 * @return:     struct cpio_data containing the address, length and

 * Return:      &struct cpio_data containing the address, length and

 *              filename (with the directory path cut off) of the found file.

 *              If you search for a filename and not for files in a directory,

 *              pass the absolute path of the filename in the cpio and make sure

lib/lru_cache.c

+2 −1
Original line number Diff line number Diff line
@@ -76,6 +76,7 @@ int lc_try_lock(struct lru_cache *lc) 
/**

 * lc_create - prepares to track objects in an active set

 * @name: descriptive name only used in lc_seq_printf_stats and lc_seq_dump_details

 * @cache: cache root pointer

 * @max_pending_changes: maximum changes to accumulate until a transaction is required

 * @e_count: number of elements allowed to be active simultaneously

 * @e_size: size of the tracked objects
@@ -627,7 +628,7 @@ void lc_set(struct lru_cache *lc, unsigned int enr, int index) 
}



/**

 * lc_dump - Dump a complete LRU cache to seq in textual form.

 * lc_seq_dump_details - Dump a complete LRU cache to seq in textual form.

 * @lc: the lru cache to operate on

 * @seq: the &struct seq_file pointer to seq_printf into

 * @utext: user supplied additional "heading" or other info

lib/parman.c

+2 −2
Original line number Diff line number Diff line
@@ -297,7 +297,7 @@ EXPORT_SYMBOL(parman_destroy); 
 * parman_prio_init - initializes a parman priority chunk

 * @parman:	parman instance

 * @prio:	parman prio structure to be initialized

 * @prority:	desired priority of the chunk

 * @priority:	desired priority of the chunk

 *

 * Note: all locking must be provided by the caller.

 *
@@ -356,7 +356,7 @@ int parman_item_add(struct parman *parman, struct parman_prio *prio, 
EXPORT_SYMBOL(parman_item_add);



/**

 * parman_item_del - deletes parman item

 * parman_item_remove - deletes parman item

 * @parman:	parman instance

 * @prio:	parman prio instance to delete the item from

 * @item:	parman item instance

lib/radix-tree.c

+6 −5
Original line number Diff line number Diff line
@@ -166,9 +166,9 @@ static inline void all_tag_set(struct radix_tree_node *node, unsigned int tag) 
/**

 * radix_tree_find_next_bit - find the next set bit in a memory region

 *

 * @addr: The address to base the search on

 * @size: The bitmap size in bits

 * @offset: The bitnumber to start searching at

 * @node: where to begin the search

 * @tag: the tag index

 * @offset: the bitnumber to start searching at

 *

 * Unrollable variant of find_next_bit() for constant size arrays.

 * Tail bits starting from size to roundup(size, BITS_PER_LONG) must be zero.
@@ -461,7 +461,7 @@ static int radix_tree_extend(struct radix_tree_root *root, gfp_t gfp, 


/**

 *	radix_tree_shrink    -    shrink radix tree to minimum height

 *	@root		radix tree root

 *	@root:		radix tree root

 */

static inline bool radix_tree_shrink(struct radix_tree_root *root)

{
@@ -691,7 +691,7 @@ static inline int insert_entries(struct radix_tree_node *node, 
}



/**

 *	__radix_tree_insert    -    insert into a radix tree

 *	radix_tree_insert    -    insert into a radix tree

 *	@root:		radix tree root

 *	@index:		index key

 *	@item:		item to insert
@@ -919,6 +919,7 @@ EXPORT_SYMBOL(radix_tree_replace_slot); 
/**

 * radix_tree_iter_replace - replace item in a slot

 * @root:	radix tree root

 * @iter:	iterator state

 * @slot:	pointer to slot

 * @item:	new item to store in the slot.

 *