From: Aditya <yashsri421@gmail.com>
To: Markus Heiser <markus.heiser@darmarit.de>, corbet@lwn.net
Cc: lukas.bulwahn@gmail.com, linux-doc@vger.kernel.org,
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: Wed, 10 Mar 2021 02:54:44 +0530 [thread overview]
Message-ID: <c673e76f-72db-bbee-39d6-f5428e765173@gmail.com> (raw)
In-Reply-To: <8959bf29-9ee1-6a1d-da18-f440232864f3@darmarit.de>
On 9/3/21 7:00 pm, Markus Heiser wrote:
>
> Am 09.03.21 um 13:53 schrieb Aditya Srivastava:
>> Starting commented lines in a file mostly contains comments describing
>> license, copyright or general information about the file.
>>
>> E.g., in sound/pci/ctxfi/ctresource.c, initial comment lines describe
>> its copyright and other related file informations.
>
> 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.
Thanks
Aditya
next prev parent reply other threads:[~2021-03-09 21:25 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-09 12:53 [RFC] scripts: kernel-doc: avoid warnings due to initial commented lines in file Aditya Srivastava
2021-03-09 13:30 ` Markus Heiser
2021-03-09 21:24 ` Aditya [this message]
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
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=c673e76f-72db-bbee-39d6-f5428e765173@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;
as well as URLs for NNTP newsgroup(s).