iommu/vt-d: fix kernel-doc syntax in file header
Subsystems (3)
PATCH 1/1 iommu/vt-d: fix kernel-doc syntax in file header
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.
--- drivers/iommu/intel/pasid.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/iommu/intel/pasid.c +1 -1
@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0 -/** +/* * intel-pasid.c - PASID idr, table and entry manipulation * * Copyright (C) 2018 Intel Corporation
Signature · 1 line
2.17.1
Quoted 10 lines · Aditya Srivastava
The opening comment mark '/**' is used for highlighting the beginning of kernel-doc comments.
The header fordrivers/iommu/intel/pasid.cfollows 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'
Quoted 4 lines
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 <[email protected]>
Thanks.
Quoted 16 lines
--- drivers/iommu/intel/pasid.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)drivers/iommu/intel/pasid.c +1
-1@@ -1,5 +1,5 @@// SPDX-License-Identifier: GPL-2.0 -/** +/* * intel-pasid.c - PASID idr, table and entry manipulation * * Copyright (C) 2018 Intel Corporation
Signature · 1 line
~Randy
Quoted 10 lines · Aditya Srivastava
The opening comment mark '/**' is used for highlighting the beginning of kernel-doc comments.
The header fordrivers/iommu/intel/pasid.cfollows 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'
Quoted 4 lines
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<[email protected]>
Queued for v5.14. Thanks!
Best regards,
baolu