Updating public getting started page with some extra debug steps.
Reviewers: zarko
Subscribers: #core_team
@@ -75,6 +75,37 @@ to the exact revisions that we test against.
Note that you don't need to have a checkout of LLVM per Kythe checkout. It's
enough to have a symlink of the `third_party/llvm/llvm` directory.
+#### Troubleshooting bazel/clang/llvm errors
+You must either have /usr/bin/clang aliased properly, or the CLANG env var set:
+
+```shell
+sudo ln -s /usr/bin/clang-3.5 /usr/bin/clang
+sudo ln -s /usr/bin/clang++-3.5 /usr/bin/clang++
+```
+
+OR:
+
+```shell
+echo 'export CLANG=/usr/bin/clang' >> ~/.bashrc
+source ~/.bashrc
+```
+
+If you ran bazel and get errors like this:
+
+```
+/home/username/kythe/third_party/zlib/BUILD:10:1: undeclared inclusion(s) in rule '//third_party/zlib:zlib':
+this rule is missing dependency declarations for the following files included by 'third_party/zlib/uncompr.c':
+ '/usr/lib/llvm-3.5/lib/clang/3.5.0/include/limits.h'
+ '/usr/lib/llvm-3.5/lib/clang/3.5.0/include/stddef.h'
+ '/usr/lib/llvm-3.5/lib/clang/3.5.0/include/stdarg.h'.
+```
+
+then you need to clean and rebuild your TOOLCHAIN:
+
+```shell
+bazel clean --expunge && bazel build @local_config_cc//:toolchain
+```
+
## Building Kythe
### Building using Bazel
