[PATCH v2] f2fs: fix kernel-doc syntax and remove file name from file header

Randy Dunlap rdunlap at infradead.org
Sat May 22 15:15:05 UTC 2021


On 5/22/21 4:43 AM, Aditya Srivastava wrote:
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> The header for include/linux/f2fs_fs.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
>  * include/linux/f2fs_fs.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 at gmail.com>

Acked-by: Randy Dunlap <rdunlap at infradead.org>

Thanks.

> ---
> Changes in v2:
> - Remove file name information from header comments, as suggested by Randy
> 
>  include/linux/f2fs_fs.h | 4 +---
>  1 file changed, 1 insertion(+), 3 deletions(-)
> 
> diff --git a/include/linux/f2fs_fs.h b/include/linux/f2fs_fs.h
> index 5487a80617a3..b5a081aa86c4 100644
> --- a/include/linux/f2fs_fs.h
> +++ b/include/linux/f2fs_fs.h
> @@ -1,7 +1,5 @@
>  // SPDX-License-Identifier: GPL-2.0
> -/**
> - * include/linux/f2fs_fs.h
> - *
> +/*
>   * Copyright (c) 2012 Samsung Electronics Co., Ltd.
>   *             http://www.samsung.com/
>   */
> 


-- 
~Randy



More information about the Linux-kernel-mentees mailing list