From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-5.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI, SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED autolearn=no autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 9EFDEC433E6 for ; Tue, 16 Feb 2021 17:06:34 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 6C7BA64DEC for ; Tue, 16 Feb 2021 17:06:34 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230001AbhBPRG0 (ORCPT ); Tue, 16 Feb 2021 12:06:26 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:57036 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229916AbhBPRGU (ORCPT ); Tue, 16 Feb 2021 12:06:20 -0500 Received: from ms.lwn.net (ms.lwn.net [IPv6:2600:3c01:e000:3a1::42]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 66001C06174A; Tue, 16 Feb 2021 09:05:40 -0800 (PST) Received: from localhost (unknown [IPv6:2601:281:8300:104d::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 15193A75; Tue, 16 Feb 2021 17:05:40 +0000 (UTC) DKIM-Filter: OpenDKIM Filter v2.11.0 ms.lwn.net 15193A75 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=lwn.net; s=20201203; t=1613495140; bh=YPle+G1Lk2amVuY3xUnjqm5Dh/EowY5kPGq9W01HOXk=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=OCHs/0XnSrIwSF6VfOhzoq0JlCiz9xFLc9mFsJKj43NhqNIyUjUuiTRxpcJiqwPHW J1IhEVE0zZIySrzdLGWlrTCNSab8yFiUBNreFoo0Zc2ck6BCXTR/ljrYu9GoaHymLj CXUawLlB2xFQWfclcvX0TnRPqxR9f6JVUpZq+sfJEaLSxhj6SbUKyDXZ0TwGImdUVT jkg9cfl3vq0DfGf4cnjuqruTdLwi+pQfUpLJX+WbWPgECj1Za5c68FiIJXih7Dj1F8 iL+L64tayUO65Z9EdcxozvnCaBcY62AJPo9BqniXLwm65AmvbHu0FcblbH4JhWKW/5 HafEy2vyHb/lA== From: Jonathan Corbet To: Andy Shevchenko Cc: Linux Kernel Mailing List , Linux Documentation List , Mauro Carvalho Chehab Subject: Re: anonymous enums in kernel doc In-Reply-To: References: <87r1lgx8fo.fsf@meer.lwn.net> Date: Tue, 16 Feb 2021 10:05:39 -0700 Message-ID: <87mtw4x7rw.fsf@meer.lwn.net> MIME-Version: 1.0 Content-Type: text/plain Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org Andy Shevchenko writes: > On Tue, Feb 16, 2021 at 6:51 PM Jonathan Corbet wrote: >> >> > Mauro, can you do some test cases in your workflow against anonymous >> > enum in ernel doc, please? >> > >> > They are broken again, please fix the script! >> > >> > drivers/pinctrl/intel/pinctrl-intel.c:204: warning: wrong kernel-doc >> > identifier on line: >> > * enum - Locking variants of the pad configuration >> > >> > Above is simply a wrong statement. >> >> The real problem, perhaps, is that there seems to be little point in >> adding kerneldoc comments for anonymous enums; where are you going to >> use that documentation? > > I had been explicitly told during review (IIRC by maintainers) to make > it such, while the initial version was exactly like you are thinking > of. So, I'm not the right person to be asked :-) > >> The error message could perhaps be changed to >> say that; meanwhile, perhaps this one could be fixed with an action like >> s%/**%/*% ? > > See above. I think regression comes from the kernel doc script, > earlier it was okay. That said, the author of kernel doc changes has > to submit a patch to amend the driver and maintainers will review it. kerneldoc now warns about various incorrect things that it used to just silently pass over. There is no regression here, just a new diagnostic to point out something that was never going to work right. Unless you have a good idea for what kerneldoc should do with a block like that? (An alternative fix, of course, would be to give the enum a name so it can actually be used for type checking.) Thanks, jon