summaryrefslogtreecommitdiffstats
path: root/Documentation/kbuild
diff options
context:
space:
mode:
authorJani Nikula <jani.nikula@intel.com>2019-06-04 15:42:48 +0300
committerMasahiro Yamada <yamada.masahiro@socionext.com>2019-06-15 19:57:02 +0900
commite846f0dc57f441e5e93194d39bc9b8ac2ab5e0a4 (patch)
treeb58f3a2e11125b3ed4f35f0c0c14380e3374b9db /Documentation/kbuild
parent0315bb7a25267bfeee2a7aaed5d1b4ba915e0c53 (diff)
downloadlinux-e846f0dc57f441e5e93194d39bc9b8ac2ab5e0a4.tar.gz
linux-e846f0dc57f441e5e93194d39bc9b8ac2ab5e0a4.tar.bz2
linux-e846f0dc57f441e5e93194d39bc9b8ac2ab5e0a4.zip
kbuild: add support for ensuring headers are self-contained
Sometimes it's useful to be able to explicitly ensure certain headers remain self-contained, i.e. that they are compilable as standalone units, by including and/or forward declaring everything they depend on. Add special target header-test-y where individual Makefiles can add headers to be tested if CONFIG_HEADER_TEST is enabled. This will generate a dummy C file per header that gets built as part of extra-y. Signed-off-by: Jani Nikula <jani.nikula@intel.com> Reviewed-by: Sam Ravnborg <sam@ravnborg.org> Signed-off-by: Masahiro Yamada <yamada.masahiro@socionext.com>
Diffstat (limited to 'Documentation/kbuild')
-rw-r--r--Documentation/kbuild/makefiles.txt7
1 files changed, 7 insertions, 0 deletions
diff --git a/Documentation/kbuild/makefiles.txt b/Documentation/kbuild/makefiles.txt
index bac301a73a86..ca4b24ec0399 100644
--- a/Documentation/kbuild/makefiles.txt
+++ b/Documentation/kbuild/makefiles.txt
@@ -1018,6 +1018,13 @@ When kbuild executes, the following steps are followed (roughly):
In this example, extra-y is used to list object files that
shall be built, but shall not be linked as part of built-in.a.
+ header-test-y
+
+ header-test-y specifies headers (*.h) in the current directory that
+ should be compile tested to ensure they are self-contained,
+ i.e. compilable as standalone units. If CONFIG_HEADER_TEST is enabled,
+ this autogenerates dummy sources to include the headers, and builds them
+ as part of extra-y.
--- 6.7 Commands useful for building a boot image