Skip to content

Commit 4e48f42

Browse files
jyn514Joshua Nelson
authored and
Joshua Nelson
committed
Remove "Skipping LLVM build" section
`download-ci-llvm` is available and enabled by default for all tier 1 platforms, so there is no need to change it. Using system LLVM over CI llvm is still supported, but is not recommended. Building LLVM from source is still supported. This also notes that you need to explicitly disable downloading LLVM when updating the submodule.
1 parent bee2fd5 commit 4e48f42

File tree

2 files changed

+9
-34
lines changed

2 files changed

+9
-34
lines changed

src/backend/updating-llvm.md

+9
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,15 @@ through each in detail.
102102
LLVM bindings. Note that you should use `#ifdef` and such to ensure that the
103103
bindings still compile on older LLVM versions.
104104

105+
Note that `profile = "compiler"` and other defaults set by `x.py setup`
106+
download LLVM from CI instead of building it from source. You should
107+
disable this temporarily to make sure your changes are being used, by setting
108+
```toml
109+
[llvm]
110+
download-ci-llvm = false
111+
```
112+
in config.toml
113+
105114
4. Test for regressions across other platforms. LLVM often has at least one bug
106115
for non-tier-1 architectures, so it's good to do some more testing before
107116
sending this to bors! If you're low on resources you can send the PR as-is

src/building/suggested.md

-34
Original file line numberDiff line numberDiff line change
@@ -201,37 +201,3 @@ git worktree add -b my-feature ../rust2 master
201201

202202
You can then use that rust2 folder as a separate workspace for modifying
203203
and building `rustc`!
204-
205-
## Skipping LLVM Build
206-
207-
By default, LLVM is built from source, and that takes significant amount of
208-
time. One way to avoid that is to add this to `config.toml`:
209-
210-
```toml
211-
[llvm]
212-
download-ci-llvm = true
213-
```
214-
215-
Downloading LLVM from CI is still experimental though, and might not be
216-
available on all platforms. Otherwise, we'd make it a default!
217-
218-
Another alternative is to use LLVM already installed on your computer. This is
219-
specified in the `target` section of `config.toml`:
220-
221-
```toml
222-
[target.x86_64-unknown-linux-gnu]
223-
llvm-config = "/path/to/llvm/llvm-7.0.1/bin/llvm-config"
224-
```
225-
226-
We have observed the following paths before, which may be different from your system:
227-
228-
- `/usr/bin/llvm-config-8`
229-
- `/usr/lib/llvm-8/bin/llvm-config`
230-
231-
Note that you need to have the LLVM `FileCheck` tool installed, which is used
232-
for codegen tests. This tool is normally built with LLVM, but if you use your
233-
own preinstalled LLVM, you will need to provide `FileCheck` in some other way.
234-
On Debian-based systems, you can install the `llvm-N-tools` package (where `N`
235-
is the LLVM version number, e.g. `llvm-8-tools`). Alternately, you can specify
236-
the path to `FileCheck` with the `llvm-filecheck` config item in `config.toml`
237-
or you can disable codegen test with the `codegen-tests` item in `config.toml`.

0 commit comments

Comments
 (0)