From: Randy Dunlap <rdunlap@infradead.org>
To: Philip Li <philip.li@intel.com>
Cc: kernel test robot <lkp@intel.com>,
llvm@lists.linux.dev, oe-kbuild-all@lists.linux.dev,
linux-doc@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>
Subject: Re: [lwn:docs-next 64/66] Warning: sound/usb/usx2y/us144mkii_controls.c:8 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst
Date: Sun, 30 Nov 2025 18:06:22 -0800 [thread overview]
Message-ID: <66a48b09-b119-435c-b8d8-474773bdf8a9@infradead.org> (raw)
In-Reply-To: <aSz2pyrJvGiVi1nv@rli9-mobl>
On 11/30/25 6:00 PM, Philip Li wrote:
> On Mon, Dec 01, 2025 at 08:43:33AM +0800, Philip Li wrote:
>> On Sun, Nov 30, 2025 at 04:20:59PM -0800, Randy Dunlap wrote:
>>> Hi,
>>> Is the robot an AI?
>>> Maybe that could help explain why a commit that fixes spelling,
>>> grammar, punctuation, etc., causes all of these kernel-doc warnings--
>>
>> Sorry about this, the bisection is buggy and identified the wrong commit
>> in this case. I will further investigate and ix the issue asap.
>
> Hi Randy, it is found the commit slightly change the warning output from "Refer Documentation"
> to "Refer to Documentation", which leads to wrong judgement that considers this
> commit as the first bad one.
>
> I will think of how to avoid this kind of false positive. Sorry again for the
> confusion.
>
> @@ -1179,7 +1179,7 @@ class KernelDoc:
> #
> else:
> self.emit_msg(ln,
> - f"This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst\n{line}")
> + f"This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst\n{line}")
>
Ah, I see. Thanks for the info.
>>
>>> all of which seem to be valid warning reports when I have a quick
>>> look at them.
--
~Randy
prev parent reply other threads:[~2025-12-01 2:06 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-11-30 23:12 [lwn:docs-next 64/66] Warning: sound/usb/usx2y/us144mkii_controls.c:8 This comment starts with '/**', but isn't a kernel-doc comment. Refer to Documentation/doc-guide/kernel-doc.rst kernel test robot
2025-12-01 0:20 ` Randy Dunlap
2025-12-01 0:43 ` Philip Li
2025-12-01 2:00 ` Philip Li
2025-12-01 2:06 ` Randy Dunlap [this message]
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=66a48b09-b119-435c-b8d8-474773bdf8a9@infradead.org \
--to=rdunlap@infradead.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=lkp@intel.com \
--cc=llvm@lists.linux.dev \
--cc=oe-kbuild-all@lists.linux.dev \
--cc=philip.li@intel.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).