linux-kernel - [PATCH -next] x86/mm: fix doc warnings in pgtable.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]
Message-ID: <20210605064519.692571-1-libaokun1@huawei.com>
Date:   Sat, 5 Jun 2021 14:45:19 +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>,
        <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: fix doc warnings in pgtable.c

Fixes the following W=1 kernel build warning(s):

 arch/x86/mm/pgtable.c:621: warning: Function parameter or 
  member 'reserve' not described in 'reserve_top_address'
 arch/x86/mm/pgtable.c:670: warning:
  Function parameter or member 'p4d' not described in 'p4d_set_huge'
 arch/x86/mm/pgtable.c:670: warning:
  Function parameter or member 'addr' not described in 'p4d_set_huge'
 arch/x86/mm/pgtable.c:670: warning:
  Function parameter or member 'prot' not described in 'p4d_set_huge'
 arch/x86/mm/pgtable.c:680: warning:
  Function parameter or member 'p4d' not described in 'p4d_clear_huge'
 arch/x86/mm/pgtable.c:705: warning:
  Function parameter or member 'pud' not described in 'pud_set_huge'
 arch/x86/mm/pgtable.c:705: warning:
  Function parameter or member 'addr' not described in 'pud_set_huge'
 arch/x86/mm/pgtable.c:705: warning:
  Function parameter or member 'prot' not described in 'pud_set_huge'
 arch/x86/mm/pgtable.c:730: warning:
  Function parameter or member 'pud' not described in 'pud_clear_huge'
 arch/x86/mm/pgtable.c:749: warning:
  Function parameter or member 'pmd' not described in 'pmd_set_huge'
 arch/x86/mm/pgtable.c:749: warning:
  Function parameter or member 'addr' not described in 'pmd_set_huge'
 arch/x86/mm/pgtable.c:749: warning:
  Function parameter or member 'prot' not described in 'pmd_set_huge'
 arch/x86/mm/pgtable.c:777: warning:
  Function parameter or member 'pmd' not described in 'pmd_clear_huge'

Signed-off-by: Baokun Li <libaokun1@...wei.com>
---
 arch/x86/mm/pgtable.c | 20 +++++++++++++-------
 1 file changed, 13 insertions(+), 7 deletions(-)

diff --git a/arch/x86/mm/pgtable.c b/arch/x86/mm/pgtable.c
index 1303ff6ef7be..2d01a5d8ad85 100644
--- a/arch/x86/mm/pgtable.c
+++ b/arch/x86/mm/pgtable.c
@@ -612,7 +612,7 @@ int pmdp_clear_flush_young(struct vm_area_struct *vma,
 
 /**
  * reserve_top_address - reserves a hole in the top of kernel address space
- * @reserve - size of hole to reserve
+ * @reserve: size of hole to reserve
  *
  * Can be used to relocate the fixmap area and poke a hole in the top
  * of kernel address space to make room for a hypervisor.
@@ -663,7 +663,9 @@ void native_set_fixmap(unsigned /* enum fixed_addresses */ idx,
 #ifdef CONFIG_X86_5LEVEL
 /**
  * p4d_set_huge - setup kernel P4D mapping
- *
+ * @p4d: Pointer to a P4D.
+ * @addr: Virtual address associated with p4d.
+ * @prot: indicates guest access rights: PROT_NONE, PROT_READ or PROT_WRITE.
  * No 512GB pages yet -- always return 0
  */
 int p4d_set_huge(p4d_t *p4d, phys_addr_t addr, pgprot_t prot)
@@ -673,7 +675,7 @@ int p4d_set_huge(p4d_t *p4d, phys_addr_t addr, pgprot_t prot)
 
 /**
  * p4d_clear_huge - clear kernel P4D mapping when it is set
- *
+ * @p4d: Pointer to a P4D.
  * No 512GB pages yet -- always return 0
  */
 int p4d_clear_huge(p4d_t *p4d)
@@ -685,7 +687,9 @@ int p4d_clear_huge(p4d_t *p4d)
 #if CONFIG_PGTABLE_LEVELS > 3
 /**
  * pud_set_huge - setup kernel PUD mapping
- *
+ * @pud: Pointer to a PUD.
+ * @addr: Virtual address associated with pud.
+ * @prot: indicates guest access rights: PROT_NONE, PROT_READ or PROT_WRITE.
  * MTRRs can override PAT memory types with 4KiB granularity. Therefore, this
  * function sets up a huge page only if any of the following conditions are met:
  *
@@ -723,7 +727,7 @@ int pud_set_huge(pud_t *pud, phys_addr_t addr, pgprot_t prot)
 
 /**
  * pud_clear_huge - clear kernel PUD mapping when it is set
- *
+ * @pud: Pointer to a PUD.
  * Returns 1 on success and 0 on failure (no PUD map is found).
  */
 int pud_clear_huge(pud_t *pud)
@@ -740,7 +744,9 @@ int pud_clear_huge(pud_t *pud)
 #if CONFIG_PGTABLE_LEVELS > 2
 /**
  * pmd_set_huge - setup kernel PMD mapping
- *
+ * @pmd: Pointer to a PMD.
+ * @addr: Virtual address associated with pmd.
+ * @prot: indicates guest access rights: PROT_NONE, PROT_READ or PROT_WRITE.
  * See text over pud_set_huge() above.
  *
  * Returns 1 on success and 0 on failure.
@@ -770,7 +776,7 @@ int pmd_set_huge(pmd_t *pmd, phys_addr_t addr, pgprot_t prot)
 
 /**
  * pmd_clear_huge - clear kernel PMD mapping when it is set
- *
+ * @pmd: Pointer to a PMD.
  * Returns 1 on success and 0 on failure (no PMD map is found).
  */
 int pmd_clear_huge(pmd_t *pmd)
-- 
2.31.1