linux-kernel - [tip: x86/cleanups] 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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <174721002225.406.1304432824733939534.tip-bot2@tip-bot2>
Date: Wed, 14 May 2025 08:07:02 -0000
From: "tip-bot2 for Shivank Garg" <tip-bot2@...utronix.de>
To: linux-tip-commits@...r.kernel.org
Cc: Shivank Garg <shivankg@....com>, Ingo Molnar <mingo@...nel.org>,
 x86@...nel.org, linux-kernel@...r.kernel.org
Subject: [tip: x86/cleanups] x86/mm/pat: Fix W=1 build kernel-doc warning

The following commit has been merged into the x86/cleanups branch of tip:

Commit-ID:     bd6afa43eee175ba146f6f9a27d6d24eeaab0a45
Gitweb:        https://git.kernel.org/tip/bd6afa43eee175ba146f6f9a27d6d24eeaab0a45
Author:        Shivank Garg <shivankg@....com>
AuthorDate:    Wed, 14 May 2025 06:26:40 
Committer:     Ingo Molnar <mingo@...nel.org>
CommitterDate: Wed, 14 May 2025 09:58:53 +02:00

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>
Signed-off-by: Ingo Molnar <mingo@...nel.org>
Link: https://lore.kernel.org/r/20250514062637.3287779-3-shivankg@amd.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 72d8cbc..51635ae 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.
  *