[PATCH -next] x86/mm/pat: fix doc warnings in memtype.c

From: Baokun Li
Date: Sat Jun 05 2021 - 02:42:19 EST


Add description for `pat_pfn_immune_to_uc_mtrr` to fix the W=1 warnings:

arch/x86/mm/pat/memtype.c:744: warning: Function parameter or
member 'pfn' not described in 'pat_pfn_immune_to_uc_mtrr'

Signed-off-by: Baokun Li <libaokun1@xxxxxxxxxx>
---
arch/x86/mm/pat/memtype.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/x86/mm/pat/memtype.c b/arch/x86/mm/pat/memtype.c
index 3112ca7786ed..3f72ff4400bd 100644
--- a/arch/x86/mm/pat/memtype.c
+++ b/arch/x86/mm/pat/memtype.c
@@ -734,7 +734,7 @@ static enum page_cache_mode lookup_memtype(u64 paddr)
/**
* pat_pfn_immune_to_uc_mtrr - Check whether the PAT memory type
* of @pfn cannot be overridden by UC MTRR memory type.
- *
+ * @pfn: The target page frame number
* Only to be called when PAT is enabled.
*
* Returns true, if the PAT memory type of @pfn is UC, UC-, or WC.
--
2.31.1