linux-kernel - [PATCH RESEND 3/4] x86/mm/pat: Fix W=1 build kernel-doc warning

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 for Android: free password hash cracker in your pocket

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

Message-ID: <20250514062637.3287779-3-shivankg@amd.com>
Date: Wed, 14 May 2025 06:26:40 +0000
From: Shivank Garg <shivankg@....com>
To: <tglx@...utronix.de>, <mingo@...hat.com>, <bp@...en8.de>,
	<dave.hansen@...ux.intel.com>, <x86@...nel.org>, <hpa@...or.com>,
	<luto@...nel.org>, <peterz@...radead.org>, <rafael@...nel.org>,
	<pavel@...nel.org>, <akpm@...ux-foundation.org>
CC: <linux-kernel@...r.kernel.org>, <linux-pm@...r.kernel.org>,
	<shivankg@....com>, <sohil.mehta@...el.com>, <rui.zhang@...el.com>,
	<yuntao.wang@...ux.dev>, <kai.huang@...el.com>, <xiaoyao.li@...el.com>,
	<peterx@...hat.com>, <sandipan.das@....com>, <ak@...ux.intel.com>,
	<rostedt@...dmis.org>
Subject: [PATCH RESEND 3/4] x86/mm/pat: Fix W=1 build kernel-doc warning

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@....com>
---
 arch/x86/mm/pat/memtype.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/arch/x86/mm/pat/memtype.c b/arch/x86/mm/pat/memtype.c
index 72d8cbc61158..51635ae1eb7f 100644
--- 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.
  *
-- 
2.34.1