* [PATCH] iommu/vt-d: fix kernel-doc syntax in file header
@ 2021-05-23 14:32 Aditya Srivastava
2021-05-23 15:52 ` Randy Dunlap
2021-06-09 7:38 ` Lu Baolu
0 siblings, 2 replies; 3+ messages in thread
From: Aditya Srivastava @ 2021-05-23 14:32 UTC (permalink / raw)
To: will
Cc: yashsri421, lukas.bulwahn, rdunlap, dwmw2, baolu.lu, joro, iommu,
linux-kernel, linux-kernel-mentees, linux-doc
The opening comment mark '/**' is used for highlighting the beginning of
kernel-doc comments.
The header for drivers/iommu/intel/pasid.c follows this syntax, but
the content inside does not comply with kernel-doc.
This line was probably not meant for kernel-doc parsing, but is parsed
due to the presence of kernel-doc like comment syntax(i.e, '/**'), which
causes unexpected warnings from kernel-doc:
warning: Function parameter or member 'fmt' not described in 'pr_fmt'
Provide a simple fix by replacing this occurrence with general comment
format, i.e. '/*', to prevent kernel-doc from parsing it.
Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
---
drivers/iommu/intel/pasid.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/drivers/iommu/intel/pasid.c b/drivers/iommu/intel/pasid.c
index 72646bafc52f..aaffb226a6a9 100644
--- a/drivers/iommu/intel/pasid.c
+++ b/drivers/iommu/intel/pasid.c
@@ -1,5 +1,5 @@
// SPDX-License-Identifier: GPL-2.0
-/**
+/*
* intel-pasid.c - PASID idr, table and entry manipulation
*
* Copyright (C) 2018 Intel Corporation
--
2.17.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] iommu/vt-d: fix kernel-doc syntax in file header
2021-05-23 14:32 [PATCH] iommu/vt-d: fix kernel-doc syntax in file header Aditya Srivastava
@ 2021-05-23 15:52 ` Randy Dunlap
2021-06-09 7:38 ` Lu Baolu
1 sibling, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2021-05-23 15:52 UTC (permalink / raw)
To: Aditya Srivastava, will
Cc: lukas.bulwahn, dwmw2, baolu.lu, joro, iommu, linux-kernel,
linux-kernel-mentees, linux-doc
On 5/23/21 7:32 AM, Aditya Srivastava wrote:
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> The header for drivers/iommu/intel/pasid.c follows this syntax, but
> the content inside does not comply with kernel-doc.
>
> This line was probably not meant for kernel-doc parsing, but is parsed
> due to the presence of kernel-doc like comment syntax(i.e, '/**'), which
> causes unexpected warnings from kernel-doc:
> warning: Function parameter or member 'fmt' not described in 'pr_fmt'
>
> Provide a simple fix by replacing this occurrence with general comment
> format, i.e. '/*', to prevent kernel-doc from parsing it.
>
> Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.
> ---
> drivers/iommu/intel/pasid.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/iommu/intel/pasid.c b/drivers/iommu/intel/pasid.c
> index 72646bafc52f..aaffb226a6a9 100644
> --- a/drivers/iommu/intel/pasid.c
> +++ b/drivers/iommu/intel/pasid.c
> @@ -1,5 +1,5 @@
> // SPDX-License-Identifier: GPL-2.0
> -/**
> +/*
> * intel-pasid.c - PASID idr, table and entry manipulation
> *
> * Copyright (C) 2018 Intel Corporation
>
--
~Randy
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] iommu/vt-d: fix kernel-doc syntax in file header
2021-05-23 14:32 [PATCH] iommu/vt-d: fix kernel-doc syntax in file header Aditya Srivastava
2021-05-23 15:52 ` Randy Dunlap
@ 2021-06-09 7:38 ` Lu Baolu
1 sibling, 0 replies; 3+ messages in thread
From: Lu Baolu @ 2021-06-09 7:38 UTC (permalink / raw)
To: Aditya Srivastava, will
Cc: baolu.lu, lukas.bulwahn, rdunlap, dwmw2, joro, iommu,
linux-kernel, linux-kernel-mentees, linux-doc
On 5/23/21 10:32 PM, Aditya Srivastava wrote:
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> The header for drivers/iommu/intel/pasid.c follows this syntax, but
> the content inside does not comply with kernel-doc.
>
> This line was probably not meant for kernel-doc parsing, but is parsed
> due to the presence of kernel-doc like comment syntax(i.e, '/**'), which
> causes unexpected warnings from kernel-doc:
> warning: Function parameter or member 'fmt' not described in 'pr_fmt'
>
> Provide a simple fix by replacing this occurrence with general comment
> format, i.e. '/*', to prevent kernel-doc from parsing it.
>
> Signed-off-by: Aditya Srivastava<yashsri421@gmail.com>
Queued for v5.14. Thanks!
Best regards,
baolu
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-06-09 7:39 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-05-23 14:32 [PATCH] iommu/vt-d: fix kernel-doc syntax in file header Aditya Srivastava
2021-05-23 15:52 ` Randy Dunlap
2021-06-09 7:38 ` Lu Baolu
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).