mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Aditya <yashsri421@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>,
	Lukas Bulwahn <lukas.bulwahn@gmail.com>
Cc: Markus Heiser <markus.heiser@darmarit.de>,
	"open list:DOCUMENTATION" <linux-doc@vger.kernel.org>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	linux-kernel-mentees@lists.linuxfoundation.org
Subject: Re: [RFC] scripts: kernel-doc: avoid warnings due to initial commented lines in file
Date: Sat, 20 Mar 2021 12:23:25 +0530	[thread overview]
Message-ID: <99a21e10-266e-b997-7048-c29a570afe0b@gmail.com> (raw)
In-Reply-To: <87o8fgpbpx.fsf@meer.lwn.net>

On 18/3/21 11:48 pm, Jonathan Corbet wrote:
> Lukas Bulwahn <lukas.bulwahn@gmail.com> writes:
> 
>> 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
> 

Thanks for the inputs Lukas and Jonathan. I shall try to come up with
something.

Thanks
Aditya

  reply	other threads:[~2021-03-20 11:14 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-09 12:53 Aditya Srivastava
2021-03-09 13:30 ` Markus Heiser
2021-03-09 21:24   ` Aditya
2021-03-10  6:19     ` Lukas Bulwahn
2021-03-11 21:03       ` Aditya
2021-03-12  7:00         ` Lukas Bulwahn
2021-03-15 19:25     ` Jonathan Corbet
2021-03-18 10:55       ` Lukas Bulwahn
2021-03-18 16:37         ` Jonathan Corbet
2021-03-18 17:52           ` Lukas Bulwahn
2021-03-18 18:18             ` Jonathan Corbet
2021-03-20  6:53               ` Aditya [this message]
2021-03-20 12:45                 ` Aditya Srivastava
2021-03-20 13:21                   ` Lukas Bulwahn
2021-03-20 13:33                     ` Aditya Srivastava

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=99a21e10-266e-b997-7048-c29a570afe0b@gmail.com \
    --to=yashsri421@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel-mentees@lists.linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lukas.bulwahn@gmail.com \
    --cc=markus.heiser@darmarit.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®