Subject: [PATCH] mm: Add kernel-doc comment for free_pgd_range()

Commit Message

SoumishDas March 25, 2025, 6:13 p.m. UTC

Provide kernel-doc for free_pgd_range() so it's easier to
understand what the function does and how it is used.

Signed-off-by: SoumishDas <[e-mail]>
---
 mm/memory.c | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

Patch

diff --git a/mm/memory.c b/mm/memory.c
index 4f6d9766a046..6b8f8692a97f 100644
--- a/mm/memory.c
+++ b/mm/memory.c
@@ -294,8 +294,17 @@  static inline void free_p4d_range(struct mmu_gather *tlb, pgd_t *pgd,
 	p4d_free_tlb(tlb, p4d, start);
 }
 
-/*
- * This function frees user-level page tables of a process.
+/**
+ * free_pgd_range - Unmap and free page tables in the range
+ * @tlb: the mmu_gather containing pending TLB flush info
+ * @addr: virtual address start
+ * @end: virtual address end
+ * @floor: lowest address boundary
+ * @ceiling: highest address boundary
+ *
+ * This function tears down all user-level page tables in the
+ * specified virtual address range [@addr..@end). It is part of
+ * the memory unmap flow.
  */
 void free_pgd_range(struct mmu_gather *tlb,
 			unsigned long addr, unsigned long end,