Skip to content

Commit b31e8a0

Browse files
authored
Fix llvm-builder installation docs (#370)
Updated installation instructions for the llvm-builder.
1 parent 903cbd7 commit b31e8a0

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,7 @@ export LLVM_SYS_181_PREFIX=</path/to/the/extracted/archive>/target-llvm/gnu/targ
7676
<details>
7777
<summary>Building from source</summary>
7878

79-
Use the provided [revive-llvm](crates/llvm-builder/README.md) utility to compile a compatible LLVM build locally and point `$LLVM_SYS_181_PREFIX` to the installation afterwards.
80-
81-
The `Makefile` provides a shortcut target to obtain a compatible LLVM build:
79+
The `Makefile` provides a shortcut target to obtain a compatible LLVM build, using the provided [revive-llvm](crates/llvm-builder/README.md) utility. Once installed, point `$LLVM_SYS_181_PREFIX` to the installation afterwards:
8280

8381
```sh
8482
make install-llvm

crates/llvm-builder/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Obtain a compatible build for your host platform from the release section of thi
5959

6060
* Install the builder using `cargo`:
6161
```shell
62-
cargo install --git https://github.com/paritytech/revive-llvm-builder --force --locked
62+
cargo install --force --locked --path crates/llvm-builder
6363
```
6464

6565
> The builder is not the LLVM framework itself, but a tool that clones its repository and runs a sequence of build commands. By default it is installed in `~/.cargo/bin/`, which is recommended to be added to your `$PATH`.
@@ -88,7 +88,12 @@ Obtain a compatible build for your host platform from the release section of thi
8888

8989
Build artifacts end up in the `./target-llvm/gnu/target-final/` directory by default.
9090
The `gnu` directory depends on the supported archticture and will either be `gnu`, `musl` or `emscripten`.
91-
You now need to export the final target directory `$LLVM_SYS_181_PREFIX`: `export LLVM_SYS_181_PREFIX=${PWD}/target-llvm/gnu/target-final`
91+
You now need to export the final target directory `$LLVM_SYS_181_PREFIX`:
92+
93+
```shell
94+
export LLVM_SYS_181_PREFIX=${PWD}/target-llvm/gnu/target-final
95+
```
96+
9297
If built with the `--enable-tests` option, test tools will be in the `./target-llvm/gnu/build-final/` directory, along with copies of the build artifacts. For all supported build options, run `revive-llvm build --help`.
9398

9499
</details>

0 commit comments

Comments
 (0)