Re: [PATCH] linux/pipe_fs_i.h: fix kernel-doc warnings after @wait was split

From: Jonathan Corbet
Date: Thu Feb 13 2020 - 09:59:44 EST


On Wed, 12 Feb 2020 11:57:39 -0800
Linus Torvalds <torvalds@xxxxxxxxxxxxxxxxxxxx> wrote:

> I've considered adding some doc building to my basic tests, but it is
> (a) somewhat slow and (b) has always been very noisy.
>
> And that (b) is why I really don't do it. The reason I require the
> basic build to be warning-free is that because that way any new
> warnings stand out. But that's just not the case for docs.
>
> What do you use to notice new errors? Or is there some trick to make
> it less noisy?

I save the output and do a diff ... not the greatest workflow.

The docs-build warnings are a huge problem, which is why getting rid of
them is at the top of my priority list. It's a fairly lonely game of
whack-a-mole at the moment, though.

Once we're there, it should be pretty easy to add a quick check that
doesn't actually build the docs and, thus, isn't so painfully slow. But
that won't really be useful until we can get the build clean.

jon