Skip to content

Commit

Permalink
Update build command in docs to use release mode (#3846)
Browse files Browse the repository at this point in the history
The [Building from
source](https://model-checking.github.io/kani/build-from-source.html)
page lists `cargo build-dev` as the command to build Kani. However, this
command builds Kani in debug/development mode where optimizations are
turned off, and thus may be much slower than the optimized binaries.
This PR updates the docs to list the command to build in release mode.

By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 and MIT licenses.
  • Loading branch information
zhassan-aws authored Jan 22, 2025
1 parent 684e233 commit 834dc41
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/src/build-from-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,16 @@ source $HOME/.cargo/env

## Build and test Kani

Build the Kani package:
Build the Kani package using:

```
cargo build-dev -- --release
```
to compile with optimizations turned on or using:
```
cargo build-dev
```
to compile in debug/development mode.

Then, optionally, run the regression tests:

Expand Down

0 comments on commit 834dc41

Please sign in to comment.