2024-02-26 10:02:27

by Kunwu Chan

Subject: [PATCH] x86/mm/pat: fix kernel-doc warning

Fix kernel-doc warning in memtype.c:
arch/x86/mm/pat/memtype.c:710: warning: Function parameter or struct member 'pfn' not described in 'pat_pfn_immune_to_uc_mtrr'

Signed-off-by: Kunwu Chan <[email protected]>
---
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 0904d7e8e126..77c86a575268 100644
--- a/arch/x86/mm/pat/memtype.c
+++ b/arch/x86/mm/pat/memtype.c
@@ -700,6 +700,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.39.2

2024-02-26 16:27:13

by Randy Dunlap

Subject: Re: [PATCH] x86/mm/pat: fix kernel-doc warning

On 2/26/24 01:04, Kunwu Chan wrote:
> Fix kernel-doc warning in memtype.c:
> arch/x86/mm/pat/memtype.c:710: warning: Function parameter or struct member 'pfn' not described in 'pat_pfn_immune_to_uc_mtrr'
>
> Signed-off-by: Kunwu Chan <[email protected]>


Reviewed-by: Randy Dunlap <[email protected]>

Thanks.


> ---
> 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 0904d7e8e126..77c86a575268 100644
> --- a/arch/x86/mm/pat/memtype.c
> +++ b/arch/x86/mm/pat/memtype.c
> @@ -700,6 +700,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.
> *

--
#Randy