Add kernel-docs to free_pages(). This will help callers understand when
to use it instead of __free_pages().

Signed-off-by: Vishal Moola (Oracle) <vishal.moola@gmail.com>
---
 mm/page_alloc.c | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/mm/page_alloc.c b/mm/page_alloc.c
index baead29b3e67..6ee8f450c078 100644
--- a/mm/page_alloc.c
+++ b/mm/page_alloc.c
@@ -5270,6 +5270,15 @@ void free_pages_nolock(struct page *page, unsigned int order)
 	___free_pages(page, order, FPI_TRYLOCK);
 }
 
+/**
+ * free_pages - Free pages allocated with alloc_pages().
+ * @addr: The virtual address tied to a page returned from alloc_pages().
+ * @order: The order of the allocation.
+ *
+ * This function behaves the same as __free_pages(). Use this function
+ * to free pages when you only have a valid virtual address. If you have
+ * the page, call __free_pages() instead.
+ */
 void free_pages(unsigned long addr, unsigned int order)
 {
 	if (addr != 0) {
-- 
2.51.0

On Tue, Aug 26, 2025 at 12:32:52PM -0700, Vishal Moola (Oracle) wrote:
> +/**
> + * free_pages - Free pages allocated with alloc_pages().

I might reference get_free_pages() here instead of alloc_pages().
We used to have a wonderful document that explained that there was one
allocator with two namespaces to access it; alloc_pages()/__free_pages()
and get_free_pages()/free_pages().  I don't know what happened to it.

Other than that,

Reviewed-by: Matthew Wilcox (Oracle) <willy@infradead.org>