Thread (3 messages) 3 messages, 3 authors, 2021-06-09

Re: [PATCH] iommu/vt-d: fix kernel-doc syntax in file header

From: Lu Baolu <baolu.lu@linux.intel.com>
Date: 2021-06-09 07:39:57
Also in: linux-iommu, linux-kernel-mentees, lkml

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<redacted>
Queued for v5.14. Thanks!

Best regards,
baolu
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help