Skip to content

Commit 35b4b10

Browse files
authored
Update developer docs after custom sysroot (model-checking#1729)
After model-checking#1717 was merged, users need to run `cargo build-dev` to build Kani binaries and the sysroot.
1 parent d86dc3b commit 35b4b10

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

docs/src/build-from-source.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ source $HOME/.cargo/env
5757
Build the Kani package:
5858

5959
```
60-
cargo build
60+
cargo build-dev
6161
```
6262

6363
Then, optionally, run the regression tests:
@@ -66,7 +66,7 @@ Then, optionally, run the regression tests:
6666
./scripts/kani-regression.sh
6767
```
6868

69-
This script has a lot of noisy output, but on a successful run you'll see:
69+
This script has a lot of noisy output, but on a successful run you'll see at the end of the execution:
7070

7171
```
7272
All Kani regression tests completed successfully.

docs/src/cheat-sheets.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ development purposes.
1010

1111
```bash
1212
# Error "'rustc' panicked at 'failed to lookup `SourceFile` in new context'"
13-
# or similar error?
14-
# Clean `kani-compiler` and re-build:
15-
cargo clean -p kani-compiler
16-
cargo build -p kani-compiler
13+
# or similar error? Cleaning artifacts might help.
14+
# Otherwise, comment the line below.
15+
cargo clean
16+
cargo build-dev
1717
```
1818

1919
### Test

docs/src/repo-crawl.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ will refer to the name as `$CONTAINER_NAME` from now on.
8484
In this step we will download the list of repositories using a script
8585
[kani-run-on-repos.sh](../../scripts/exps/kani-run-on-repos.sh)
8686

87-
Make sure to have Kani ready to run. If not, compile with `cargo build`.
87+
Make sure to have Kani ready to run. For that, see the [build instructions](cheat-sheets.md#build).
8888

8989
From the repository root, you can run the script with
9090
`./scripts/exps/kani-run-on-repos.sh $URL_LIST_FILE` where

docs/src/rustc-hacks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ Finally, override the current toolchain in your kani workspace and rebuild kani:
199199
cd ${KANI_WORKSPACE}
200200
rustup override set custom-toolchain
201201
cargo clean
202-
cargo build
202+
cargo build-dev
203203
```
204204

205205
# Enable `rustc` logs

0 commit comments

Comments
 (0)