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=-11.6 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH, MAILING_LIST_MULTI,NICE_REPLY_A,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED,USER_AGENT_SANE_1 autolearn=unavailable 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 37F97C4741F for ; Fri, 30 Oct 2020 16:49:31 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id A073720756 for ; Fri, 30 Oct 2020 16:49:30 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="bQ54/X+n" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727055AbgJ3Qta (ORCPT ); Fri, 30 Oct 2020 12:49:30 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:56914 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725844AbgJ3Qt3 (ORCPT ); Fri, 30 Oct 2020 12:49:29 -0400 Received: from casper.infradead.org (casper.infradead.org [IPv6:2001:8b0:10b:1236::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7DB28C0613CF; Fri, 30 Oct 2020 09:49:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; h=Content-Transfer-Encoding:Content-Type: In-Reply-To:MIME-Version:Date:Message-ID:From:References:Cc:To:Subject:Sender :Reply-To:Content-ID:Content-Description; bh=bLkVPUZj71HqYK7QTvtXQx4ZFoQRz5HBYZMu9LxVxOk=; b=bQ54/X+nUFyGnYfsDHFjttzPMr EkV0OjHqDeWDb9DwMfZM+LTYjGA2KivyIVg3dhIuj68A0GI6Imqf2JYgh38YJlqVwnOcybT1FwT7V n+txOHf0jpbRyf+UxLMP7XIL0mx2y7vEoZiNHJSZGC9m/jxGW/6SnN8k3Zk5PGw9BJ5uvE/9UhAem aPQ2GmIV3HotoN3oMes1tNQ0OdMOk4Lra4JoCDgFiNLn2Q0VbHbsZ6UC4WsM9b22J9DrKxW/e9t52 EvNPqGoQge0kROLYZ5ekDd6GgtIlCnKdrHfEAo3OfzqH6xaZllyK1uCDo8A0YCJSuQXrOGAMLz1+C pbEQoSAQ==; Received: from [2601:1c0:6280:3f0::371c] by casper.infradead.org with esmtpsa (Exim 4.92.3 #3 (Red Hat Linux)) id 1kYXab-0008UR-PW; Fri, 30 Oct 2020 16:49:22 +0000 Subject: Re: [PATCH v2 26/39] docs: Kconfig/Makefile: add a check for broken ABI files To: Mauro Carvalho Chehab , Linux Doc Mailing List Cc: Jonathan Corbet , "Paul E. McKenney" , Andrew Morton , Changbin Du , Jonathan Cameron , Krzysztof Kozlowski , Masahiro Yamada , Oded Gabbay , Peter Enderborg , Tom Rix , Vaibhav Jain , linux-kernel@vger.kernel.org References: <57a38de85cb4b548857207cf1fc1bf1ee08613c9.1604042072.git.mchehab+huawei@kernel.org> From: Randy Dunlap Message-ID: <4bc8b5ff-4797-4fa9-c2fe-5813be18d50b@infradead.org> Date: Fri, 30 Oct 2020 09:49:16 -0700 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:68.0) Gecko/20100101 Thunderbird/68.12.0 MIME-Version: 1.0 In-Reply-To: <57a38de85cb4b548857207cf1fc1bf1ee08613c9.1604042072.git.mchehab+huawei@kernel.org> Content-Type: text/plain; charset=utf-8 Content-Language: en-US Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Hi Mauro, On 10/30/20 12:40 AM, Mauro Carvalho Chehab wrote: > The files under Documentation/ABI should follow the syntax > as defined at Documentation/ABI/README. > > Allow checking if they're following the syntax by running > the ABI parser script on COMPILE_TEST. > > With that, when there's a problem with a file under > Documentation/ABI, it would produce a warning like: > > Warning: file ./Documentation/ABI/testing/sysfs-bus-pci-devices-aer_stats#14: > What '/sys/bus/pci/devices//aer_stats/aer_rootport_total_err_cor' doesn't have a description > Warning: file ./Documentation/ABI/testing/sysfs-bus-pci-devices-aer_stats#21: > What '/sys/bus/pci/devices//aer_stats/aer_rootport_total_err_fatal' doesn't have a description > > Signed-off-by: Mauro Carvalho Chehab > --- > Documentation/Kconfig | 10 ++++++++++ > Documentation/Makefile | 5 +++++ > lib/Kconfig.debug | 2 ++ > scripts/get_abi.pl | 14 +++++++++++--- > 4 files changed, 28 insertions(+), 3 deletions(-) > > diff --git a/Documentation/Kconfig b/Documentation/Kconfig > index 66046fa1c341..e549a61f4d96 100644 > --- a/Documentation/Kconfig > +++ b/Documentation/Kconfig > @@ -10,4 +10,14 @@ config WARN_MISSING_DOCUMENTS > > If unsure, select 'N'. > > +config WARN_ABI_ERRORS > + bool "Warn if there are errors at ABI files" > + depends on COMPILE_TEST > + help > + The files under Documentation/ABI should follow what's > + described at Documentation/ABI/README. Yet, as they're manually > + written, it would be possible that some of those files would > + have errors that would break them for being parsed by > + scripts/get_abi.pl. Add a check to verify them. > > + If unsure, select 'N'. I need a bot for this: Please follow coding-style for Kconfig files: from Documentation/process/coding-style.rst, section 10): For all of the Kconfig* configuration files throughout the source tree, the indentation is somewhat different. Lines under a ``config`` definition are indented with one tab, while help text is indented an additional two spaces. thanks. -- ~Randy