From: Baokun Li <libaokun1@huawei.com>
To: <dave.hansen@linux.intel.com>, <luto@kernel.org>,
<peterz@infradead.org>, <tglx@linutronix.de>, <mingo@redhat.com>,
<bp@alien8.de>, <x86@kernel.org>, <hpa@zytor.com>,
<linux-kernel@vger.kernel.org>
Cc: <weiyongjun1@huawei.com>, <yuehaibing@huawei.com>,
<yangjihong1@huawei.com>, <yukuai3@huawei.com>,
<libaokun1@huawei.com>
Subject: [PATCH -next] x86/mm: fix doc warnings in pgtable.c
Date: Sat, 5 Jun 2021 14:45:19 +0800 [thread overview]
Message-ID: <20210605064519.692571-1-libaokun1@huawei.com> (raw)
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@huawei.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
reply other threads:[~2021-06-05 6:36 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210605064519.692571-1-libaokun1@huawei.com \
--to=libaokun1@huawei.com \
--cc=bp@alien8.de \
--cc=dave.hansen@linux.intel.com \
--cc=hpa@zytor.com \
--cc=linux-kernel@vger.kernel.org \
--cc=luto@kernel.org \
--cc=mingo@redhat.com \
--cc=peterz@infradead.org \
--cc=tglx@linutronix.de \
--cc=weiyongjun1@huawei.com \
--cc=x86@kernel.org \
--cc=yangjihong1@huawei.com \
--cc=yuehaibing@huawei.com \
--cc=yukuai3@huawei.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).