Skip to content

Update developer docs after custom sysroot #1729

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 29, 2022
Merged

Update developer docs after custom sysroot #1729

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e2e5436
Update developer docs after custom sysroot
celinval Sep 29, 2022
d8be5d8
Update cheat-sheets.md
celinval Sep 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/src/build-from-source.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ source $HOME/.cargo/env
Build the Kani package:

```
cargo build
cargo build-dev
```

Then, optionally, run the regression tests:
Expand All @@ -66,7 +66,7 @@ Then, optionally, run the regression tests:
./scripts/kani-regression.sh
```

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

```
All Kani regression tests completed successfully.
Expand Down
8 changes: 4 additions & 4 deletions docs/src/cheat-sheets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ development purposes.

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

### Test
Expand Down
2 changes: 1 addition & 1 deletion docs/src/repo-crawl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ will refer to the name as `$CONTAINER_NAME` from now on.
In this step we will download the list of repositories using a script
[kani-run-on-repos.sh](../../scripts/exps/kani-run-on-repos.sh)

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

From the repository root, you can run the script with
`./scripts/exps/kani-run-on-repos.sh $URL_LIST_FILE` where
Expand Down
2 changes: 1 addition & 1 deletion docs/src/rustc-hacks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ Finally, override the current toolchain in your kani workspace and rebuild kani:
cd ${KANI_WORKSPACE}
rustup override set custom-toolchain
cargo clean
cargo build
cargo build-dev
```

# Enable `rustc` logs
Expand Down