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>
---
include/linux/f2fs_fs.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
From: Randy Dunlap <rdunlap@infradead.org> Date: 2021-05-20 18:34:58
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 <rdunlap@infradead.org>
Even better would be to remove the filename from the file.
Thanks.
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 <redacted>
---
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(-)
From: Randy Dunlap <rdunlap@infradead.org> Date: 2021-05-22 15:15:12
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 <redacted>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.
quoted hunk
---
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(-)