Re: [PATCH v2] Phonet: fix kernel-doc syntax in file headers and remove file names

Rémi Denis-Courmont
2021-05-23T08:11:23Z

Le samedi 22 mai 2021, 14:34:08 EEST Aditya Srivastava a écrit :
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> For e.g., the header for include/linux/phonet.h 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 warning from kernel-doc:
> warning: This comment starts with '/**', but isn't a kernel-doc comment.
> Refer Documentation/doc-guide/kernel-doc.rst * file phonet.h
>
> Provide a simple fix by replacing this occurrence with general comment
> format, i.e. '/*', to prevent kernel-doc from parsing it.
>
> Also remove the redundant file name from the comment headers.
>
> Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>

Acked-by: Rémi Denis-Courmont <courmisch@gmail.com>

> ---
> Changes in v2:
> - Remove file name information from comment headers as well, as suggested by
> Randy and Remi
>
> include/linux/phonet.h | 4 +---
> include/uapi/linux/phonet.h | 4 +---
> 2 files changed, 2 insertions(+), 6 deletions(-)
>
> diff --git a/include/linux/phonet.h b/include/linux/phonet.h
> index bc7d1e529efc..6117a0e462d3 100644
> --- a/include/linux/phonet.h
> +++ b/include/linux/phonet.h
> @@ -1,7 +1,5 @@
> /* SPDX-License-Identifier: GPL-2.0-only */
> -/**
> - * file phonet.h
> - *
> +/*
> * Phonet sockets kernel interface
> *
> * Copyright (C) 2008 Nokia Corporation. All rights reserved.
> diff --git a/include/uapi/linux/phonet.h b/include/uapi/linux/phonet.h
> index a2f6b37a5937..e7e14b5e59c6 100644
> --- a/include/uapi/linux/phonet.h
> +++ b/include/uapi/linux/phonet.h
> @@ -1,7 +1,5 @@
> /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
> -/**
> - * file phonet.h
> - *
> +/*
> * Phonet sockets kernel interface
> *
> * Copyright (C) 2008 Nokia Corporation. All rights reserved.

--
Rémi Denis-Courmont