Re: [PATCH] f2fs: fix kernel-doc syntax in file header
From: Randy Dunlap <hidden>
Date: 2021-05-20 18:34:58
Also in:
linux-f2fs-devel, linux-kernel-mentees, lkml
On 5/20/21 11:29 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. Signed-off-by: Aditya Srivastava <redacted>
Acked-by: Randy Dunlap <redacted> Even better would be to remove the filename from the file. Thanks.
quoted hunk ↗ jump to hunk
--- include/linux/f2fs_fs.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)diff --git a/include/linux/f2fs_fs.h b/include/linux/f2fs_fs.h index 5487a80617a3..028d1b18f0e7 100644 --- a/include/linux/f2fs_fs.h +++ b/include/linux/f2fs_fs.h@@ -1,5 +1,5 @@ // SPDX-License-Identifier: GPL-2.0 -/** +/* * include/linux/f2fs_fs.h * * Copyright (c) 2012 Samsung Electronics Co., Ltd.
-- ~Randy