aboutsummaryrefslogtreecommitdiff
path: root/docs/markdown/snippets
diff options
context:
space:
mode:
authorNirbheek Chauhan <nirbheek@centricular.com>2018-05-30 14:24:59 +0530
committerNirbheek Chauhan <nirbheek@centricular.com>2018-05-30 15:25:39 +0530
commit27b290d6dff14fdb7717d414fb941aca0fd2dc55 (patch)
tree05f8b0a6afa47fdb934b26bdd3280c138295eb4b /docs/markdown/snippets
parentff07314a865d960aac2c377a94de766b68888ee5 (diff)
downloadmeson-27b290d6dff14fdb7717d414fb941aca0fd2dc55.zip
meson-27b290d6dff14fdb7717d414fb941aca0fd2dc55.tar.gz
meson-27b290d6dff14fdb7717d414fb941aca0fd2dc55.tar.bz2
Add check_header to Reference manual and release notes [skip ci]
Diffstat (limited to 'docs/markdown/snippets')
-rw-r--r--docs/markdown/snippets/compiler_check_header.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/markdown/snippets/compiler_check_header.md b/docs/markdown/snippets/compiler_check_header.md
new file mode 100644
index 0000000..8981d13
--- /dev/null
+++ b/docs/markdown/snippets/compiler_check_header.md
@@ -0,0 +1,12 @@
+## New compiler check: check_header()
+
+The existing compiler check `has_header()` only checks if the header exists,
+either with the `__has_include` C++11 builtin, or by running the pre-processor.
+
+However, sometimes the header you are looking for is unusable on some platforms
+or with some compilers in a way that is only detectable at compile-time. For
+such cases, you should use `check_header()` which will include the header and
+run a full compile.
+
+Note that `has_header()` is much faster than `check_header()`, so it should be
+used whenever possible.