summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKim Grasman <kim.grasman@gmail.com>2018-12-26 16:42:12 +0100
committerKim Gräsman <kim.grasman@gmail.com>2018-12-26 16:54:21 +0100
commitac6ce5f2fac9bdd269772b0651b559eb92bc09ad (patch)
tree0f739a28613340095548bf770217b64356b2daf7
parent6f8c0020f0cd3ff6a0678c418d32562119821754 (diff)
Freshen up How to Install section
There were some ambiguities, especially with non-standard packaging. Recommend -print-resource-dir to find builtins and try to clarify.
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index 324e673..e107a84 100644
--- a/README.md
+++ b/README.md
@@ -75,7 +75,9 @@ Clang's default policy is to look in `path/to/clang-executable/../lib/clang/<cla
Clang tools have the same policy by default, so in order for IWYU to analyze any non-trivial code, it needs to find Clang's built-ins in `path/to/iwyu/../lib/clang/3.5.0/include` where `3.5.0` is a stand-in for the version of Clang your IWYU was built against.
-So for IWYU to function correctly, you need to copy in the Clang headers at a good location before running.
+Note that some distributions/packages may have different defaults, you can use `clang -print-resource-dir` to find the base path of the built-in headers on your system.
+
+So for IWYU to function correctly, you need to copy the Clang `include` directory to the expected location before running (similarly, use `include-what-you-use -print-resource-dir` to learn exactly where IWYU wants the headers).
This weirdness is tracked in [issue 100](https://github.com/include-what-you-use/include-what-you-use/issues/100), hopefully we can make this more transparent over time.