[PATCH] mm/swap.c: fix kernel-doc functions and parameters
From: Randy Dunlap
Date: Sun Jan 28 2018 - 23:02:39 EST
From: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Fix some basic kernel-doc notation in mm/swap.c:
- make function names in kernel-doc notation match the functions
- make function parameter names in kernel-doc match the actual parameters
Fix function kernel-doc to match the change in commit 67fd707f4681:
- drop the kernel-doc notation for @nr_pages from pagevec_lookup_range()
and correct the function description for that change
Fixes 67fd707f4681:
("mm: remove nr_pages argument from pagevec_lookup_{,range}_tag()")
Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Cc: Jan Kara <jack@xxxxxxx>
---
mm/swap.c | 17 ++++++++---------
1 file changed, 8 insertions(+), 9 deletions(-)
--- lnx-415.orig/mm/swap.c
+++ lnx-415/mm/swap.c
@@ -400,6 +400,10 @@ void mark_page_accessed(struct page *pag
}
EXPORT_SYMBOL(mark_page_accessed);
+/**
+ * __lru_cache_add: add a page to the page lists
+ * @page: the page to add
+ */
static void __lru_cache_add(struct page *page)
{
struct pagevec *pvec = &get_cpu_var(lru_add_pvec);
@@ -410,10 +414,6 @@ static void __lru_cache_add(struct page
put_cpu_var(lru_add_pvec);
}
-/**
- * lru_cache_add: add a page to the page lists
- * @page: the page to add
- */
void lru_cache_add_anon(struct page *page)
{
if (PageActive(page))
@@ -913,11 +913,11 @@ EXPORT_SYMBOL(__pagevec_lru_add);
* @pvec: Where the resulting entries are placed
* @mapping: The address_space to search
* @start: The starting entry index
- * @nr_entries: The maximum number of entries
+ * @nr_pages: The maximum number of entries
* @indices: The cache indices corresponding to the entries in @pvec
*
* pagevec_lookup_entries() will search for and return a group of up
- * to @nr_entries pages and shadow entries in the mapping. All
+ * to @nr_pages pages and shadow entries in the mapping. All
* entries are placed in @pvec. pagevec_lookup_entries() takes a
* reference against actual pages in @pvec.
*
@@ -965,9 +965,8 @@ void pagevec_remove_exceptionals(struct
* @mapping: The address_space to search
* @start: The starting page index
* @end: The final page index
- * @nr_pages: The maximum number of pages
*
- * pagevec_lookup_range() will search for and return a group of up to @nr_pages
+ * pagevec_lookup_range() will search for & return a group of up to PAGEVEC_SIZE
* pages in the mapping starting from index @start and upto index @end
* (inclusive). The pages are placed in @pvec. pagevec_lookup() takes a
* reference against the pages in @pvec.
@@ -977,7 +976,7 @@ void pagevec_remove_exceptionals(struct
* also update @start to index the next page for the traversal.
*
* pagevec_lookup_range() returns the number of pages which were found. If this
- * number is smaller than @nr_pages, the end of specified range has been
+ * number is smaller than PAGEVEC_SIZE, the end of specified range has been
* reached.
*/
unsigned pagevec_lookup_range(struct pagevec *pvec,