linux-kernel - Re: [PATCH v2] samples: bpf: ix 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: <33cd99d5-8d4a-df36-8ab0-e68da879aa69@infradead.org>
Date:   Sun, 23 May 2021 09:07:54 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Aditya Srivastava <yashsri421@...il.com>, kafai@...com
Cc:     lukas.bulwahn@...il.com, linux-kernel@...r.kernel.org,
        linux-kernel-mentees@...ts.linuxfoundation.org,
        linux-doc@...r.kernel.org, dledford@...hat.com, jgg@...pe.ca,
        ast@...nel.org, daniel@...earbox.net, andrii@...nel.org,
        songliubraving@...com, yhs@...com, john.fastabend@...il.com,
        kpsingh@...nel.org, linux-rdma@...r.kernel.org,
        netdev@...r.kernel.org, bpf@...r.kernel.org
Subject: Re: [PATCH v2] samples: bpf: ix kernel-doc syntax in file header

On 5/23/21 8:14 AM, Aditya Srivastava wrote:
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> The header for samples/bpf/ibumad_kern.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: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>  * ibumad BPF sample kernel side
> 
> 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.

> ---
> Changes in v2: Include changes for both, samples/bpf/ibumad_kern.c and samples/bpf/ibumad_user.c in the same patch
> 
>  samples/bpf/ibumad_kern.c | 2 +-
>  samples/bpf/ibumad_user.c | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/samples/bpf/ibumad_kern.c b/samples/bpf/ibumad_kern.c
> index 26dcd4dde946..9b193231024a 100644
> --- a/samples/bpf/ibumad_kern.c
> +++ b/samples/bpf/ibumad_kern.c
> @@ -1,6 +1,6 @@
>  // SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB
>  
> -/**
> +/*
>   * ibumad BPF sample kernel side
>   *
>   * This program is free software; you can redistribute it and/or
> diff --git a/samples/bpf/ibumad_user.c b/samples/bpf/ibumad_user.c
> index d83d8102f489..0746ca516097 100644
> --- a/samples/bpf/ibumad_user.c
> +++ b/samples/bpf/ibumad_user.c
> @@ -1,6 +1,6 @@
>  // SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB
>  
> -/**
> +/*
>   * ibumad BPF sample user side
>   *
>   * This program is free software; you can redistribute it and/or
> 


-- 
~Randy