Received: by 2002:a05:6a10:22f:0:0:0:0 with SMTP id 15csp815088pxk; Thu, 1 Oct 2020 14:43:21 -0700 (PDT) X-Google-Smtp-Source: ABdhPJw0xiVLrqqKB7CgSJNUisayvIscrSxvbWHsDOTjWz9AsMGFS6vVE5fjKlKBQB1WjwSOW7MS X-Received: by 2002:a17:906:9353:: with SMTP id p19mr10128157ejw.403.1601588600708; Thu, 01 Oct 2020 14:43:20 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1601588600; cv=none; d=google.com; s=arc-20160816; b=Ey+iX3UxdLoD7feTbdGwMXc0PswEl3BmD8vofaoBwk0zEKwAPfoGJY315lMshb091r 1Pca3x/nwRR14gqYgbBYhmcn1+Dbi5mP39GXx/pzo7/tUgBnn0bSpS28T24iAScwxJKf zM5sC4g/QYprDNYWLERst+77wG6XAzHOmAKCguJq0pTZ5TfqGn6qTQBYW/K2eQA8Ofoa 8SPnqlOXOXV6cF4B9MsF1X+6B42mwQgJfW5W3lV4TeP/UfUXKTu/WLPTGRsqogfQxkJ6 o3cTVjk5ae3duI3Z2jKdPHcx1Q780cxR2ivksd5mt8ZGztg6o6RszsI/Ves2HFACodH6 fiMA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :organization:references:in-reply-to:message-id:subject:cc:to:from :date; bh=Ws6zqLlslVoaNfRCc9BIHUxMcl9x+jB9L5dTbostoDk=; b=oqxx0pK5M64B1eMWvEjLbGgRYbAq/KVbuJu2gZLWRzeHgRi97rV+COs29Mnru4suql XYIGmQt/L9HVhqMlTWUgGAhANRLsUbhOz6/Y6QJfxG6E/9/wKtAyFZYeiHLWjZVMaAOL 5FVNDS9XUM0hiuPhneaevAqIXAwHZHXwnBLGSHij3W0rv8ybuxfNpXNAt7Ne77K5rihV jK2cgjpv/7kHn+llL4xGMJKKMuQHXJbYR75olZxCfHEVTa+1vHhKXLF07hJzxT0foAML JyonH8a8YFLlPhuy84RNTwqdFFqr6KRiNL/L8jTaF56ohKHxQtNTjZPKfZfMTKEj1ByP RSrg== ARC-Authentication-Results: i=1; mx.google.com; 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 r16si4323306edt.192.2020.10.01.14.42.58; Thu, 01 Oct 2020 14:43:20 -0700 (PDT) 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; 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 S1733130AbgJAVlF (ORCPT + 99 others); Thu, 1 Oct 2020 17:41:05 -0400 Received: from ms.lwn.net ([45.79.88.28]:39388 "EHLO ms.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1733113AbgJAVlE (ORCPT ); Thu, 1 Oct 2020 17:41:04 -0400 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 53769537; Thu, 1 Oct 2020 21:41:04 +0000 (UTC) Date: Thu, 1 Oct 2020 15:41:00 -0600 From: Jonathan Corbet To: Mauro Carvalho Chehab Cc: Linux Doc Mailing List , linux-kernel@vger.kernel.org Subject: Re: [PATCH v4 04/52] scripts: kernel-doc: make it more compatible with Sphinx 3.x Message-ID: <20201001154100.2f7e89b8@lwn.net> In-Reply-To: References: Organization: LWN.net MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Wed, 30 Sep 2020 15:24:27 +0200 Mauro Carvalho Chehab wrote: > With Sphinx 3.x, the ".. c:type:" tag was changed to accept either: > > .. c:type:: typedef-like declaration > .. c:type:: name > > Using it for other types (including functions) don't work anymore. > > So, there are newer tags for macro, enum, struct, union, and others, > which doesn't exist on older versions. > > Add a check for the Sphinx version and change the produced tags > accordingly. > > Signed-off-by: Mauro Carvalho Chehab > --- > scripts/kernel-doc | 71 ++++++++++++++++++++++++++++++++++++++++++---- > 1 file changed, 65 insertions(+), 6 deletions(-) So this seems generally good, but I do wonder if we shouldn't just pass the sphinx version into kernel-doc as a parameter? We're already doing a version check in the makefile, we should be able to capture the result and pass it in, maybe? jon