Re: [PATCH v2 26/39] docs: Kconfig/Makefile: add a check for broken ABI files

From: Randy Dunlap <rdunlap@infradead.org>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
	Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
	"Paul E. McKenney" <paulmck@kernel.org>,
	Andrew Morton <akpm@linux-foundation.org>,
	Changbin Du <changbin.du@intel.com>,
	Jonathan Cameron <Jonathan.Cameron@huawei.com>,
	Krzysztof Kozlowski <krzk@kernel.org>,
	Masahiro Yamada <masahiroy@kernel.org>,
	Oded Gabbay <oded.gabbay@gmail.com>,
	Peter Enderborg <peter.enderborg@sony.com>,
	Tom Rix <trix@redhat.com>, Vaibhav Jain <vaibhav@linux.ibm.com>,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 26/39] docs: Kconfig/Makefile: add a check for broken ABI files
Date: Fri, 30 Oct 2020 09:49:16 -0700	[thread overview]
Message-ID: <4bc8b5ff-4797-4fa9-c2fe-5813be18d50b@infradead.org> (raw)
In-Reply-To: <57a38de85cb4b548857207cf1fc1bf1ee08613c9.1604042072.git.mchehab+huawei@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/<dev>/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/<dev>/aer_stats/aer_rootport_total_err_fatal' doesn't have a description
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
>  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