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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <cb50b161-5a72-7eb6-f912-3583ebd75d33@linux.intel.com>
Date:   Wed, 9 Jun 2021 15:38:34 +0800
From:   Lu Baolu <baolu.lu@...ux.intel.com>
To:     Aditya Srivastava <yashsri421@...il.com>, will@...nel.org
Cc:     baolu.lu@...ux.intel.com, lukas.bulwahn@...il.com,
        rdunlap@...radead.org, dwmw2@...radead.org, joro@...tes.org,
        iommu@...ts.linux-foundation.org, linux-kernel@...r.kernel.org,
        linux-kernel-mentees@...ts.linuxfoundation.org,
        linux-doc@...r.kernel.org
Subject: Re: [PATCH] iommu/vt-d: fix kernel-doc syntax in file header

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@...il.com>

Queued for v5.14. Thanks!

Best regards,
baolu