about summary refs log tree commit diff
path: root/src/doc/rustc-dev-guide
diff options
context:
space:
mode:
authorWho? Me?! <mark-i-m@users.noreply.github.com>2019-12-31 06:46:49 -0600
committerSantiago Pastorino <spastorino@gmail.com>2019-12-31 09:46:49 -0300
commitc7aee944bbd93e8079faa839b63dac0593bb65da (patch)
treef9de824e8ceca3383696cedce7b3b8331eab8f7c /src/doc/rustc-dev-guide
parent095a0f3c1702c76de96ff7bd426d789209033848 (diff)
downloadrust-c7aee944bbd93e8079faa839b63dac0593bb65da.tar.gz
rust-c7aee944bbd93e8079faa839b63dac0593bb65da.zip
More info about using local LLVM (#547)
* more info about llvm-config

* typo

Co-Authored-By: Santiago Pastorino <spastorino@gmail.com>

Co-authored-by: Santiago Pastorino <spastorino@gmail.com>
Diffstat (limited to 'src/doc/rustc-dev-guide')
-rw-r--r--src/doc/rustc-dev-guide/src/building/suggested.md14
1 files changed, 12 insertions, 2 deletions
diff --git a/src/doc/rustc-dev-guide/src/building/suggested.md b/src/doc/rustc-dev-guide/src/building/suggested.md
index 07f834eacd6..087e9dee866 100644
--- a/src/doc/rustc-dev-guide/src/building/suggested.md
+++ b/src/doc/rustc-dev-guide/src/building/suggested.md
@@ -74,5 +74,15 @@ This is specified in the `target` section of `config.toml`:
 llvm-config = "/path/to/llvm/llvm-7.0.1/bin/llvm-config"
 ```
 
-On my system, this path is `/usr/bin/llvm-config-7`, but this probably varies
-by installation.
+We have observed the following paths before, which may be different from your system:
+
+- `/usr/bin/llvm-config-8`
+- `/usr/lib/llvm-8/bin/llvm-config`
+
+Note that you need to have the LLVM `FileCheck` tool installed, which is used
+for codegen tests. This tool is normally built with LLVM, but if you use your
+own preinstalled LLVM, you will need to provide `FileCheck` in some other way.
+On Debian-based systems, you can install the `llvm-N-tools` package (where `N`
+is the LLVM version number, e.g. `llvm-8-tools`).  Alternately, you can specify
+the path to `FileCheck` with the `llvm-filecheck` config item in `config.toml`
+or you can disable codegen test with the `codegen-tests` item in `config.toml`.