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

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>] [day] [month] [year] [list]

Date:   Sat, 5 Jun 2021 14:51:30 +0800
From:   Baokun Li <libaokun1@...wei.com>
To:     <dave.hansen@...ux.intel.com>, <luto@...nel.org>,
        <peterz@...radead.org>, <tglx@...utronix.de>, <mingo@...hat.com>,
        <bp@...en8.de>, <x86@...nel.org>, <hpa@...or.com>,
        <akpm@...ux-foundation.org>, <jan.kiszka@...mens.com>,
        <rppt@...nel.org>, <neilb@...e.de>, <linux-kernel@...r.kernel.org>
CC:     <weiyongjun1@...wei.com>, <yuehaibing@...wei.com>,
        <yangjihong1@...wei.com>, <yukuai3@...wei.com>,
        <libaokun1@...wei.com>
Subject: [PATCH -next] x86/mm/pat: fix doc warnings in memtype.c

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@...wei.com>
---
 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