From: Jonathan Corbet <corbet@lwn.net>
To: Vegard Nossum <vegard.nossum@oracle.com>,
Randy Dunlap <rdunlap@infradead.org>,
linux-kernel@vger.kernel.org
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
linux-doc@vger.kernel.org
Subject: Re: [PATCH] scripts/kernel-doc: restore warning for Excess struct/union
Date: Thu, 21 Dec 2023 08:20:14 -0700 [thread overview]
Message-ID: <877cl7a8gh.fsf@meer.lwn.net> (raw)
In-Reply-To: <93e1b9fa-c447-4f7d-9dc7-825ebe9e1cde@oracle.com>
Vegard Nossum <vegard.nossum@oracle.com> writes:
> On 15/12/2023 17:28, Jonathan Corbet wrote:
>> *sigh*
>>
>> This adds nearly 600 new warnings. Anybody gonna help fix them?
>
> I think in the vast majority of the cases the fix will be to just remove
> the offending line from the kerneldoc, so it's not particularly
> difficult, mostly just overhead from the patch preparation/submission
> process.
>
> I'd be happy to take a stab at it -- I think we could even script most
> of it. Respond here, I guess, if anybody else wants to do some so we can
> split it up.
It's mostly done; I've gotten it down to under 200 and sent patches to
make the changes. Randy is working on it too, I know. It's not always
just deletion, but the fixes are usually pretty straightforward.
> On a related note, it might be useful to have some kind of "status page"
> somewhere on the web for the docs where you can see a list of unresolved
> documentation warnings in mainline/docs-next/next without having to do a
> local build first (as a way to solicit contributions).
I suppose, but how do you know you've properly addressed the warning if
you don't do a build afterward? I don't see that saving a whole lot of
effort, but maybe I'm missing something?
Thanks,
jon
next prev parent reply other threads:[~2023-12-21 15:20 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-14 7:02 [PATCH] scripts/kernel-doc: restore warning for Excess struct/union Randy Dunlap
2023-12-14 7:05 ` Randy Dunlap
2023-12-15 1:02 ` Kees Cook
2023-12-15 5:35 ` kernel test robot
2023-12-15 5:38 ` Randy Dunlap
2023-12-15 6:48 ` kernel test robot
2023-12-15 16:28 ` Jonathan Corbet
2023-12-21 13:48 ` Vegard Nossum
2023-12-21 15:20 ` Jonathan Corbet [this message]
2023-12-21 16:26 ` Vegard Nossum
2023-12-22 20:11 ` Randy Dunlap
2023-12-22 23:54 ` Jonathan Corbet
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=877cl7a8gh.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@s-opensource.com \
--cc=rdunlap@infradead.org \
--cc=vegard.nossum@oracle.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.