From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <linux-next-owner@kernel.org>
X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on
	aws-us-west-2-korg-lkml-1.web.codeaurora.org
Received: from vger.kernel.org (vger.kernel.org [23.128.96.18])
	by smtp.lore.kernel.org (Postfix) with ESMTP id 6E843C4332F
	for <linux-next@archiver.kernel.org>; Thu, 10 Nov 2022 20:43:50 +0000 (UTC)
Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand
        id S231985AbiKJUnt (ORCPT <rfc822;linux-next@archiver.kernel.org>);
        Thu, 10 Nov 2022 15:43:49 -0500
Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48504 "EHLO
        lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org
        with ESMTP id S231967AbiKJUns (ORCPT
        <rfc822;linux-next@vger.kernel.org>); Thu, 10 Nov 2022 15:43:48 -0500
Received: from ms.lwn.net (ms.lwn.net [IPv6:2600:3c01:e000:3a1::42])
        by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 190224D5DD
        for <linux-next@vger.kernel.org>; Thu, 10 Nov 2022 12:43:47 -0800 (PST)
Received: from localhost (unknown [IPv6:2601:281:8300:73::5f6])
        (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
        (No client certificate requested)
        by ms.lwn.net (Postfix) with ESMTPSA id 867912CB;
        Thu, 10 Nov 2022 20:43:44 +0000 (UTC)
DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 867912CB
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203;
        t=1668113024; bh=4LcTONyiLyLVkTe5BAYLb5ptVLcYspwd8D5C7sLwB8M=;
        h=From:To:Cc:Subject:In-Reply-To:References:Date:From;
        b=h7BymJ1j/R3RBMfanqMCdTq2mqwWNrmTz9Palwj0nxQv5pU5aJAqWtSeWjRh1gqpU
         7BwwpJsqIL0SBZh+pPr5L3+2ZHTwZH5Y289j8n636i3q1k4FPYsJhHf+OVa+Ia4gZr
         SmEjXO5y+m9lbnV7Uptk9d2C0T1aa/mXiRztzbcKaiRGehan9QvOSklRxAx0/I3VSi
         x8kUM0ACr9dvN7oZa/SUn3+an9bD7/M5QKCfSz/btcZznV1JxMXvLadWxzbQKJ0/uU
         SCaRVxi6BTXgBfME+psovLlFuQ2dcgLSvPnlmaHwM4yDLwMViPOvKWcETTkps2nVOG
         8DlrEwm4ZbV7A==
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
In-Reply-To: <e523ce8c-9c60-13de-7e91-a553de985838@infradead.org>
References: <20221110183352.08cc2303@canb.auug.org.au>
 <CAHk-=wiyYSrBiOKJEV3phOBDT7EMgdXCnDUrp57E8HGNT4SFdA@mail.gmail.com>
 <e523ce8c-9c60-13de-7e91-a553de985838@infradead.org>
Date:   Thu, 10 Nov 2022 13:43:43 -0700
Message-ID: <87a64yh75s.fsf@meer.lwn.net>
MIME-Version: 1.0
Content-Type: text/plain
Precedence: bulk
List-ID: <linux-next.vger.kernel.org>
X-Mailing-List: linux-next@vger.kernel.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