Re: [PATCH] Phonet: fix kernel-doc syntax in file headers
From: Rémi Denis-Courmont <hidden>
Date: 2021-05-22 09:35:20
Also in:
linux-doc, lkml
From: Rémi Denis-Courmont <hidden>
Date: 2021-05-22 09:35:20
Also in:
linux-doc, lkml
Le jeudi 20 mai 2021, 21:21:59 EEST Aditya Srivastava a écrit :
The opening comment mark '/**' is used for highlighting the beginning of kernel-doc comments. The header for include/*/linux/phonet.h files 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. For e.g., running scripts/kernel-doc -none include/linux/phonet.h emits: 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. Signed-off-by: Aditya Srivastava <redacted>
You could just as well remove the stray "file XX" lines but OK. Acked-by: Rémi Denis-Courmont <redacted> -- Rémi Denis-Courmont _______________________________________________ Linux-kernel-mentees mailing list Linux-kernel-mentees@lists.linuxfoundation.org https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees