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=-0.8 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS 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 782C1C43331 for ; Thu, 7 Nov 2019 18:45:12 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 559872178F for ; Thu, 7 Nov 2019 18:45:12 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727478AbfKGSpL (ORCPT ); Thu, 7 Nov 2019 13:45:11 -0500 Received: from ms.lwn.net ([45.79.88.28]:38948 "EHLO ms.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726859AbfKGSpK (ORCPT ); Thu, 7 Nov 2019 13:45:10 -0500 Received: from lwn.net (localhost [127.0.0.1]) (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 1B1156EC; Thu, 7 Nov 2019 18:45:10 +0000 (UTC) Date: Thu, 7 Nov 2019 11:45:09 -0700 From: Jonathan Corbet To: Jonathan =?UTF-8?B?TmV1c2Now6RmZXI=?= Cc: linux-doc@vger.kernel.org, "Paul E . McKenney" , Joel Fernandes , linux-kernel@vger.kernel.org Subject: Re: [PATCH] scripts/kernel-doc: Add support for named variable macro arguments Message-ID: <20191107114509.16ad9f5c@lwn.net> In-Reply-To: <20191107134133.14690-1-j.neuschaefer@gmx.net> References: <20191107134133.14690-1-j.neuschaefer@gmx.net> Organization: LWN.net MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Thu, 7 Nov 2019 14:41:33 +0100 Jonathan Neuschäfer wrote: > Currently, when kernel-doc encounters a macro with a named variable > argument[1], such as this: > > #define hlist_for_each_entry_rcu(pos, head, member, cond...) > > ... it expects the variable argument to be documented as `cond...`, > rather than `cond`. This is semantically wrong, because the name (as > used in the macro body) is actually `cond`. > > With this patch, kernel-doc will accept the name without dots (`cond` > in the example above) in doc comments, and warn if the name with dots > (`cond...`) is used and verbose mode[2] is enabled. This is a definite improvement, thanks. Applied. jon