Commit 21db296a authored by Matthew Wilcox (Oracle)'s avatar Matthew Wilcox (Oracle) Committed by Andrew Morton
Browse files

mm: add kernel-doc for folio_mark_accessed() 

Convert the existing documentation to kernel-doc and remove references to
pages.

Link: https://lkml.kernel.org/r/20240424191914.361554-7-willy@infradead.org


Signed-off-by: default avatarMatthew Wilcox (Oracle) <willy@infradead.org>
Signed-off-by: default avatarAndrew Morton <akpm@linux-foundation.org>
parent 9cbe4954

mm/swap.c

+10 −7
Original line number Diff line number Diff line
@@ -447,15 +447,18 @@ static void folio_inc_refs(struct folio *folio) 
}

#endif /* CONFIG_LRU_GEN */



/*

 * Mark a page as having seen activity.

/**

 * folio_mark_accessed - Mark a folio as having seen activity.

 * @folio: The folio to mark.

 *

 * This function will perform one of the following transitions:

 *

 * inactive,unreferenced	->	inactive,referenced

 * inactive,referenced		->	active,unreferenced

 * active,unreferenced		->	active,referenced

 * * inactive,unreferenced	->	inactive,referenced

 * * inactive,referenced	->	active,unreferenced

 * * active,unreferenced	->	active,referenced

 *

 * When a newly allocated page is not yet visible, so safe for non-atomic ops,

 * __SetPageReferenced(page) may be substituted for mark_page_accessed(page).

 * When a newly allocated folio is not yet visible, so safe for non-atomic ops,

 * __folio_set_referenced() may be substituted for folio_mark_accessed().

 */

void folio_mark_accessed(struct folio *folio)

{