linux-kernel - [PATCH] Subject: [PATCH] mm: Add kernel-doc comment for free_pgd

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-Id: <20250325181325.5774-1-soumish.das@gmail.com>
Date: Tue, 25 Mar 2025 23:43:25 +0530
From: SoumishDas <soumish.das@...il.com>
To: akpm@...ux-foundation.org
Cc: linux-mm@...ck.org,
	linux-kernel@...r.kernel.org,
	SoumishDas <soumish.das@...il.com>
Subject: [PATCH] Subject: [PATCH] mm: Add kernel-doc comment for free_pgd_range()

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 <soumish.das@...il.com>
---
 mm/memory.c | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

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,
-- 
2.34.1