mirror of
https://github.com/torvalds/linux
synced 2024-07-08 20:29:39 +00:00
75442fb0cc
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 <corbet@lwn.net> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/57a38de85cb4b548857207cf1fc1bf1ee08613c9.1604042072.git.mchehab+huawei@kernel.org Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
24 lines
789 B
Plaintext
24 lines
789 B
Plaintext
config WARN_MISSING_DOCUMENTS
|
|
|
|
bool "Warn if there's a missing documentation file"
|
|
depends on COMPILE_TEST
|
|
help
|
|
It is not uncommon that a document gets renamed.
|
|
This option makes the Kernel to check for missing dependencies,
|
|
warning when something is missing. Works only if the Kernel
|
|
is built from a git tree.
|
|
|
|
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'.
|