OrgACRN
/
acrn-kernel
mirror of https://github.com/projectacrn/acrn-kernel.git
1
0
Fork 0
Code Issues Releases Wiki Activity
acrn-kernel/Documentation/Kconfig

29 lines
782 B
Plaintext
Raw Normal View History

Documentation: Avoid duplicate Kconfig inclusion Documentation/Kconfig is already included from top-level, avoid including it again from lib/Kconfig.debug. Signed-off-by: Peter Foley <pefoley2@pefoley.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> Tested-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20230114-doc-v2-1-853a8434ac95@pefoley.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2023-01-17 06:58:10 +08:00
if COMPILE_TEST
menu "Documentation"
docs: Kbuild/Makefile: allow check for missing docs at build time While this doesn't make sense for production Kernels, in order to avoid regressions when documents are touched, let's add a check target at the make file. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-06-04 20:26:27 +08:00
config WARN_MISSING_DOCUMENTS
bool "Warn if there's a missing documentation file"
help
docs: Kconfig: Fix help text indentation The convention for help text indentation seems to be a single tab followed by two whitespaces. Do that. While at it, remove a stray empty line. Signed-off-by: Juerg Haefliger <juergh@canonical.com> Link: https://lore.kernel.org/r/20220517140837.331298-1-juergh@canonical.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-05-17 22:08:37 +08:00
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.
docs: Kbuild/Makefile: allow check for missing docs at build time While this doesn't make sense for production Kernels, in order to avoid regressions when documents are touched, let's add a check target at the make file. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-06-04 20:26:27 +08:00
docs: Kconfig: Fix help text indentation The convention for help text indentation seems to be a single tab followed by two whitespaces. Do that. While at it, remove a stray empty line. Signed-off-by: Juerg Haefliger <juergh@canonical.com> Link: https://lore.kernel.org/r/20220517140837.331298-1-juergh@canonical.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-05-17 22:08:37 +08:00
If unsure, select 'N'.
docs: Kbuild/Makefile: allow check for missing docs at build time While this doesn't make sense for production Kernels, in order to avoid regressions when documents are touched, let's add a check target at the make file. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-06-04 20:26:27 +08:00
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 <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>
2020-10-30 15:40:45 +08:00
config WARN_ABI_ERRORS
bool "Warn if there are errors at ABI files"
help
docs: Kconfig: Fix help text indentation The convention for help text indentation seems to be a single tab followed by two whitespaces. Do that. While at it, remove a stray empty line. Signed-off-by: Juerg Haefliger <juergh@canonical.com> Link: https://lore.kernel.org/r/20220517140837.331298-1-juergh@canonical.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-05-17 22:08:37 +08:00
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.
docs: Kbuild/Makefile: allow check for missing docs at build time While this doesn't make sense for production Kernels, in order to avoid regressions when documents are touched, let's add a check target at the make file. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2019-06-04 20:26:27 +08:00
docs: Kconfig: Fix help text indentation The convention for help text indentation seems to be a single tab followed by two whitespaces. Do that. While at it, remove a stray empty line. Signed-off-by: Juerg Haefliger <juergh@canonical.com> Link: https://lore.kernel.org/r/20220517140837.331298-1-juergh@canonical.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2022-05-17 22:08:37 +08:00
If unsure, select 'N'.
Documentation: Avoid duplicate Kconfig inclusion Documentation/Kconfig is already included from top-level, avoid including it again from lib/Kconfig.debug. Signed-off-by: Peter Foley <pefoley2@pefoley.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> Tested-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20230114-doc-v2-1-853a8434ac95@pefoley.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2023-01-17 06:58:10 +08:00
endmenu
endif