path: root/Documentation/Kconfig
diff options
authorMauro Carvalho Chehab <>2020-10-30 08:40:45 +0100
committerGreg Kroah-Hartman <>2020-10-30 13:08:07 +0100
commit75442fb0ccaacddf1654a5304401a9f556c61004 (patch)
tree80edc2b8fac5ed9138d92b2c2df240626d77c8b6 /Documentation/Kconfig
parent50865d041eead18b110e589674ff91ffcd243e7e (diff)
docs: Kconfig/Makefile: add a check for broken ABI files
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 Acked-by: Jonathan Corbet <> Signed-off-by: Mauro Carvalho Chehab <> Link: Signed-off-by: Greg Kroah-Hartman <>
Diffstat (limited to 'Documentation/Kconfig')
1 files changed, 10 insertions, 0 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'.
+ 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/ Add a check to verify them.
+ If unsure, select 'N'.