[RFC] scripts: kernel-doc: avoid warnings due to initial commented lines in file

Jonathan Corbet corbet at lwn.net
Mon Mar 15 19:25:51 UTC 2021

Aditya <yashsri421 at gmail.com> writes:

>> The opening comment mark /** is used for kernel-doc comments [1]
>> [1]
>> https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html#how-to-format-kernel-doc-comments
> Hi Markus!
> That's true. But the content inside the comment does not follow
> kernel-doc format.
> For e.g., try running kernel-doc -none/man/rst on the above file in
> the example("sound/pci/ctxfi/ctresource.c").
> The starting 2-3 lines in files generally do not contain any
> struct/enum/function, etc. declaration.

The problem is that it's marked as a kerneldoc comment without actually
being one; it looks like somebody's internal corporate formatting.  The
fix is not to put a hack into kernel-doc - we have more than enough of
those in the file already!  The right thing to do is to remove the extra
"*" so that the comment doesn't look like a kerneldoc comment anymore.



More information about the Linux-kernel-mentees mailing list