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@xxxxxxxxxx> > --- > 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
