x86/mm/pat: Fix W=1 build kernel-doc warning

shivankgarg98 · ingomolnar · commit bd6afa43eee1 · 2025-05-14T09:58:53.000+02:00
Building the kernel with W=1 generates the following warning: arch/x86/mm/pat/memtype.c:692: warning: Function parameter or struct member 'pfn' not described in 'pat_pfn_immune_to_uc_mtrr' Add missing parameter documentation to fix the kernel-doc warning. Signed-off-by: Shivank Garg <shivankg@amd.com> Signed-off-by: Ingo Molnar <mingo@kernel.org> Link: https://lore.kernel.org/r/20250514062637.3287779-3-shivankg@amd.com
diff --git a/arch/x86/mm/pat/memtype.c b/arch/x86/mm/pat/memtype.c
@@ -682,6 +682,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 page frame number to check.
  *
  * Only to be called when PAT is enabled.
  *

Original file line number	Diff line number	Diff line change
`@@ -682,6 +682,7 @@ static enum page_cache_mode lookup_memtype(u64 paddr)`
`682`	`682`	`/**`
`683`	`683`	`* pat_pfn_immune_to_uc_mtrr - Check whether the PAT memory type`
`684`	`684`	`* of @pfn cannot be overridden by UC MTRR memory type.`
	`685`	`+ * @pfn: The page frame number to check.`
`685`	`686`	`*`
`686`	`687`	`* Only to be called when PAT is enabled.`
`687`	`688`	`*`