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] [thread-next>] [day] [month] [year] [list]

Message-ID: <e61efeb6-1a04-dc29-81ae-792fde6aa857@infradead.org>
Date:   Sun, 23 May 2021 08:52:38 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Aditya Srivastava <yashsri421@...il.com>, will@...nel.org
Cc:     lukas.bulwahn@...il.com, dwmw2@...radead.org,
        baolu.lu@...ux.intel.com, 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 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@...il.com>

Acked-by: Randy Dunlap <rdunlap@...radead.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