Skip to content

Commit a91619f

Browse files
authored
Update coverage flag in docs (#3626)
TL; DR: `/s/line-coverage/source-coverage` Starting Kani 0.55.0, the unstable flag required for enabling `--coverage` was changed from `-Zline-coverage` to `-Zsource-coverage`. Updating the documentation to reflect this change. By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 and MIT licenses.
1 parent 9238997 commit a91619f

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/src/reference/experimental/coverage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Fortunately, Kani is able to report a coverage metric for each proof harness.
1414
In the `first-steps-v2` directory, try running:
1515

1616
```
17-
cargo kani --coverage -Z line-coverage --harness verify_success
17+
cargo kani --coverage -Z source-coverage --harness verify_success
1818
```
1919

2020
which verifies the harness, then prints coverage information for each line.

docs/src/tutorial-real-code.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ A first proof will likely start in the following form:
7474
Running Kani on this simple starting point will help figure out:
7575

7676
1. What unexpected constraints might be needed on your inputs (using `kani::assume`) to avoid "expected" failures.
77-
2. Whether you're over-constrained. Check the coverage report using `--coverage -Z line-coverage`. Ideally you'd see 100% coverage, and if not, it's usually because you've assumed too much (thus over-constraining the inputs).
77+
2. Whether you're over-constrained. Check the coverage report using `--coverage -Z source-coverage`. Ideally you'd see 100% coverage, and if not, it's usually because you've assumed too much (thus over-constraining the inputs).
7878
3. Whether Kani will support all the Rust features involved.
7979
4. Whether you've started with a tractable problem.
8080
(Remember to try setting `#[kani::unwind(1)]` to force early termination and work up from there.)

0 commit comments

Comments
 (0)