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'
Signed-off-by: Randy Dunlap
Cc: Andrew Morton
Cc: Philipp Reisner
Cc: Lars Ellenberg
Cc: drbd-...@lists.linbit.com
Cc: Jiri Pirko
Cc: net...@vger.kernel.org
Cc: Matthew Wilcox
---
lib/earlycpio.c |4 ++--
lib/lru_cache.c |3 ++-
lib/parman.c |4 ++--
lib/radix-tree.c | 11 ++-
4 files changed, 12 insertions(+), 10 deletions(-)
--- linux-next-20210409.orig/lib/earlycpio.c
+++ linux-next-20210409/lib/earlycpio.c
@@ -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: 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
--- linux-next-20210409.orig/lib/lru_cache.c
+++ linux-next-20210409/lib/lru_cache.c
@@ -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, unsign
}
/**
- * 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 seq_file pointer to seq_printf into
* @utext: user supplied additional "heading" or other info
--- linux-next-20210409.orig/lib/parman.c
+++ linux-next-20210409/lib/parman.c
@@ -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 *parma
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
--- linux-next-20210409.orig/lib/radix-tree.c
+++ linux-next-20210409/lib/radix-tree.c
@@ -166,9 +166,9 @@ static inline void all_tag_set(struct ra
/**
* 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 @@ out:
/**
* radix_tree_shrink-shrink radix tree to minimum height
- * @root
