x86/mm/pat: Fix W=1 build kernel-doc warning
authorShivank Garg <shivankg@amd.com>
Wed, 14 May 2025 06:26:40 +0000 (06:26 +0000)
committerIngo Molnar <mingo@kernel.org>
Wed, 14 May 2025 07:58:53 +0000 (09:58 +0200)
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
arch/x86/mm/pat/memtype.c

index 72d8cbc..51635ae 100644 (file)
@@ -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.
  *