From: Jonathan Corbet <corbet@lwn.net>
To: Aditya Srivastava <yashsri421@gmail.com>
Cc: lukas.bulwahn@gmail.com,
linux-kernel-mentees@lists.linuxfoundation.org,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] scripts: kernel-doc: add warning for comment not following kernel-doc syntax
Date: Wed, 31 Mar 2021 13:32:09 -0600 [thread overview]
Message-ID: <87mtujktl2.fsf@meer.lwn.net> (raw)
In-Reply-To: <a35096d5-99e7-6b69-c959-1136d511a0ff@gmail.com>
Aditya Srivastava <yashsri421@gmail.com> writes:
> On 29/3/21 7:26 pm, Jonathan Corbet wrote:
>> Aditya Srivastava <yashsri421@gmail.com> writes:
>>
>>> Currently, kernel-doc start parsing the comment as a kernel-doc comment if
>>> it starts with '/**', but does not take into account if the content inside
>>> the comment too, adheres with the expected format.
>>> This results in unexpected and unclear warnings for the user.
>>>
>>> E.g., running scripts/kernel-doc -none mm/memcontrol.c emits:
>>> "mm/memcontrol.c:961: warning: expecting prototype for do not fallback to current(). Prototype was for get_mem_cgroup_from_current() instead"
>>>
>>> Here kernel-doc parses the corresponding comment as a kernel-doc comment
>>> and expects prototype for it in the next lines, and as a result causing
>>> this warning.
>>>
>>> Provide a clearer warning message to the users regarding the same, if the
>>> content inside the comment does not follow the kernel-doc expected format.
>>>
>>> Signed-off-by: Aditya Srivastava <yashsri421@gmail.com>
>>> ---
>>> scripts/kernel-doc | 17 +++++++++++++----
>>> 1 file changed, 13 insertions(+), 4 deletions(-)
>>
>> This is definitely a capability we want, but I really don't think that
>> we can turn it on by default - for now. Experience shows that if you
>> create a blizzard of warnings, nobody sees any of them. How many
>> warnings does this add to a full docs build?
>>
>
> Hi Jonathan, here's the diff I have created for the warnings before
> and after the changes:
> https://github.com/AdityaSrivast/kernel-tasks/blob/master/random/kernel-doc/kernel_doc_comment_syntax.txt
>
> Around ~1320 new warnings of this type are added to the kernel tree,
> and around ~1580 warnings are removed.
So I finally got around to looking at this again... How did you
generate that file?
I tried applying the patch and doing a normal full htmldocs build and
got all of four warnings:
./include/linux/seqlock.h:829: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* DEFINE_SEQLOCK(sl) - Define a statically allocated seqlock_t
./fs/jbd2/journal.c:1391: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* journal_t * jbd2_journal_init_dev() - creates and initialises a journal structure
./fs/jbd2/journal.c:1422: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* journal_t * jbd2_journal_init_inode () - creates a journal which maps to a inode.
./include/linux/dcache.h:309: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* dget, dget_dlock - get a reference to a dentry
Two observations:
- This is not an awful lot of warnings - not the blizzard I had
feared. At this level, I think we can just merge the patch and
then, hopefully, fix those cases.
- All of the warned-about places are *attempts* to write real kerneldoc
comments, they just got the syntax wrong in one way or another. It's
probably not worth the effort to try to detect this case - the
warning is enough to draw attention to the comment in question.
Thanks,
jon
next prev parent reply other threads:[~2021-03-31 19:33 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-29 9:29 [PATCH] scripts: kernel-doc: add warning for comment not following kernel-doc syntax Aditya Srivastava
2021-03-29 12:49 ` kernel test robot
2021-03-29 13:56 ` Jonathan Corbet
2021-03-29 15:10 ` Aditya Srivastava
2021-03-31 19:32 ` Jonathan Corbet [this message]
2021-04-03 12:43 ` Aditya Srivastava
2021-03-29 14:57 ` kernel test robot
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=87mtujktl2.fsf@meer.lwn.net \
--to=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=yashsri421@gmail.com \
/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).