Received: by 2002:a05:6a10:16a7:0:0:0:0 with SMTP id gp39csp550696pxb; Thu, 5 Nov 2020 07:03:30 -0800 (PST) X-Google-Smtp-Source: ABdhPJwJpz1ZydNNucH1KaYpY/qd3smV7FkONqSychNKsxNXUqGuRw/loYxG8jEIJ79owncSxCjN X-Received: by 2002:a5d:4e8f:: with SMTP id e15mr3711098wru.390.1604588610319; Thu, 05 Nov 2020 07:03:30 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1604588610; cv=none; d=google.com; s=arc-20160816; b=B6Nx0yHiUmbGnBYiCh3O74W94ZCsF/VZ81JUH7JWus/7W/nhREG99BQhz4Ho/RkBNR u2eb4sRnriKa/w8lBUVyOo4Uyz4ZehrnPly2L7HNV7ipcHWdWDkm4ESamlHHK60/005G 6XEpVUvlvXtnjANzVeaaUjkgUk/vottYMEsrHEiyKU9MC4+geHdM5/EX+BGbqqToUp+5 C/Fc/Of/mv1BQc/77YxwJe2qS/l1p+2xfBEiFhDEPdDAcflJM0p0YAI5YXVBNrNEYz63 yFaEg98rgkxPYDJBv304AZUrpdXZrmXJOO29hASui/NvRZeHpXU9kUNhG76URUd0Xq5Q V/yg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:in-reply-to:content-disposition:mime-version :references:message-id:subject:cc:to:from:date:dkim-signature; bh=/abP978i8fSQssBpWowZMWNHrfqF74CKuQx5R+Ko4q8=; b=JOHdvDipsLsY+bahi3A2bQle7Lf6VsPk5EbFc+bMQ7ocakA7lPPYa6sSbrOOxCjTB1 V1wKe1Trb+rip3QbSftQMtoy0ALpN11oeuo/dDQqUoA5flVLjABa0ixlIY7UvivBYvyJ FsZ3t0rhxLOsAHMSe+WRVqkiJgOECU4VNonSDg3D8x8uuSZi0yEjmw166HV1Op3eeMZ8 Su6oy56ILl1rmuDpGeRntp4pZwhAHh22FLcjc2EyUlHf7M9I9HibVt8xi+Qllq0/JPbJ ZAV6f3gLtDZsGxGIG/R9TOvf5SscD/hew08gxhlyl0jqkedl4gs/PMgvHesQyyPZ9Wkg Qslg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@infradead.org header.s=casper.20170209 header.b=QPE6XwbQ; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [23.128.96.18]) by mx.google.com with ESMTP id m6si1282362edb.517.2020.11.05.07.03.05; Thu, 05 Nov 2020 07:03:30 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18; Authentication-Results: mx.google.com; dkim=pass header.i=@infradead.org header.s=casper.20170209 header.b=QPE6XwbQ; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1731171AbgKEPAX (ORCPT + 99 others); Thu, 5 Nov 2020 10:00:23 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:49396 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1730854AbgKEPAT (ORCPT ); Thu, 5 Nov 2020 10:00:19 -0500 Received: from casper.infradead.org (casper.infradead.org [IPv6:2001:8b0:10b:1236::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E56DFC0613CF; Thu, 5 Nov 2020 07:00:18 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; h=In-Reply-To:Content-Type:MIME-Version: References:Message-ID:Subject:Cc:To:From:Date:Sender:Reply-To: Content-Transfer-Encoding:Content-ID:Content-Description; bh=/abP978i8fSQssBpWowZMWNHrfqF74CKuQx5R+Ko4q8=; b=QPE6XwbQsnFE9Vg4cul0wx02Ky DU5hbMExC8IszNS/6+pNlnGundeA1AVUVWnFatXxRoJUvcAx7fO8C66doRSiQ5P01gek+3MlvlmVb CLyooHl/+gN+AVHLjXV07MVR16Q3pqOKSe7oMUayvP05JH4uFPfuoWew6RLUtF1IlTvme1RsROZxg EKnybJPoCe4p2ZUgT62TUb+7FV8rEfu3MlsSqd5ARDDcLxZI9tJVKCjGbNzt+eNvAU9LfwQ+vCiF3 Z7Sl8dD3ZnBeHt/IzpRnV4te8HRy4VGO9EjJTW7Bfemmu6prO9rHyoMxz667rhG2lWHA9OXM9B99Q APcBHtJw==; Received: from willy by casper.infradead.org with local (Exim 4.92.3 #3 (Red Hat Linux)) id 1kagkL-0007TV-7x; Thu, 05 Nov 2020 15:00:17 +0000 Date: Thu, 5 Nov 2020 15:00:17 +0000 From: Matthew Wilcox To: Mauro Carvalho Chehab Cc: Linux Doc Mailing List , Jonathan Corbet , linux-kernel@vger.kernel.org Subject: Re: [PATCH v3 56/56] scrpits: kernel-doc: validate kernel-doc markup with the actual names Message-ID: <20201105150017.GL17076@casper.infradead.org> References: MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Fri, Oct 23, 2020 at 06:33:43PM +0200, Mauro Carvalho Chehab wrote: > Kernel-doc currently expects that the kernel-doc markup to come > just before the function/enum/struct/union/typedef prototype. > > Yet, if it find things like: > > /** > * refcount_add - add a value to a refcount > * @i: the value to add to the refcount > * @r: the refcount > */ > static inline void __refcount_add(int i, refcount_t *r, int *oldp); > static inline void refcount_add(int i, refcount_t *r); > > Kernel-doc will do the wrong thing: I wonder if we could change kernel-doc to be (optionally) less verbose. If we allowed people to write: /** * Add a value to a refcount. * @i: The value to add to the refcount * @r: The refcount */ and had the kernel-doc script pick up the name of the following function automatically, would that be an improvement we could all agree on?