Thread (15 messages) flat view 15 messages, 4 authors, 2021-03-20

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

From: Aditya Srivastava <hidden>
Date: 2021-03-20 12:46:28
Also in: linux-kernel-mentees, lkml

On 20/3/21 12:23 pm, Aditya wrote:
On 18/3/21 11:48 pm, Jonathan Corbet wrote:
quoted
Lukas Bulwahn [off-list ref] writes:
quoted
Yeah, and as this line-counting is really just a poor man's
heuristics, we might just be better to really turn this heuristics
into a dedicated cleanup warning script, then we can check for more
indicators, such as "does it contain the word Copyright" somewhere in
the kernel-doc comment, which tells us even more that this is not a
kernel-doc as we would expect it.
I really don't think we need that kind of heuristic.  The format of
kerneldoc comments is fairly rigid; it shouldn't be too hard to pick out
the /** comments that don't fit that format, right?  Am I missing
something there?

Thanks,

jon
Hi Lukas and Jon!
I have a question, should I clean up the files with '/**' like
comments in only header lines? Or as we are planning for making it
generic, for other lines as well?

Thanks
Aditya
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help