Re: linux-next: build warning after merge of the mm tree

From: Jonathan Corbet <corbet@lwn.net>
To: Randy Dunlap <rdunlap@infradead.org>,
	Linus Torvalds <torvalds@linux-foundation.org>,
	Stephen Rothwell <sfr@canb.auug.org.au>
Cc: Andrew Morton <akpm@linux-foundation.org>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
	Linux Next Mailing List <linux-next@vger.kernel.org>,
	Linux Doc Mailing List <linux-doc@vger.kernel.org>
Subject: Re: linux-next: build warning after merge of the mm tree
Date: Thu, 10 Nov 2022 13:43:43 -0700	[thread overview]
Message-ID: <87a64yh75s.fsf@meer.lwn.net> (raw)
In-Reply-To: <e523ce8c-9c60-13de-7e91-a553de985838@infradead.org>

Randy Dunlap <rdunlap@infradead.org> writes:

> Looks like scripts/kernel-doc is deficient in parsing
>
> struct encoded_page;
>
> without having any { ... }
>
> and it doesn't handle "typedef union" or "typedef struct". :(

It's never needed to do that before...it's not often we document
structure types that don't actually exist :)  kernel-doc wants to be
able to check that all of the fields and such are documented, so it
tries to parse the whole thing.

In this case, the right solution might be to just write kerneldoc
comments for the accessor functions instead, since that's what will
actually be used.

jon