Skip to content

Commit c7bf528

Browse files
authored
Update docs before 0.0.6 release (#128)
1 parent da3617b commit c7bf528

File tree

3 files changed

+25
-3
lines changed

3 files changed

+25
-3
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Kani Visual Studio Code Extension
22

3-
A [Visual Studio Code](https://code.visualstudio.com/) extension that allows users to run and debug their [Kani Rust Verifier](https://github.com/model-checking/kani) harnesses in vscode.
3+
A [Visual Studio Code](https://code.visualstudio.com/) extension that allows users to run and debug their [Kani Rust Verifier](https://github.com/model-checking/kani) harnesses in VS Code.
44

55
## Usage
66

@@ -22,7 +22,7 @@ Check [user guide](docs/user-guide.md) for more detailed information.
2222
## Requirements
2323

2424
- [Visual Studio Code](https://code.visualstudio.com/) 1.50 or newer
25-
- [Kani](https://github.com/model-checking/kani) 0.29 or newer
25+
- [Kani](https://github.com/model-checking/kani) 0.34 or newer
2626

2727
NOTE: The extension only works on Cargo packages. For standalone Rust files, Kani is only available on the command line.
2828

docs/user-guide.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ This guide provides the various workflows that you can use to verify and debug y
1616
- [View trace report in window](#view-trace-report-in-window)
1717
- [Kani output logging](#kani-output-logging)
1818
- [View full Kani output](#view-full-kani-output)
19+
- [Coverage information](#coverage-information)
20+
- [View coverage information](#view-coverage-information)
1921

2022
### Verify Kani harnesses
2123

@@ -81,7 +83,7 @@ By clicking the `Generate report for (your harness)` option in the error banner,
8183
You can click on the `Preview in Editor` button to view the HTML trace within VSCode.
8284
It should look like this:
8385

84-
![Generate Report](../resources/screenshots/view-report.png)
86+
![View Report](../resources/screenshots/view-report.png)
8587

8688

8789
### Kani output logging
@@ -91,3 +93,23 @@ It should look like this:
9193
For every test run, you can view the full output from Kani logged into the output channel as a text file. To view the log, open the output channel, and click on the channel drop down list to view a channel called `Output (Kani): ...`
9294

9395
![Generate Report](../resources/screenshots/view-output.png)
96+
97+
### Coverage information
98+
99+
Line-based coverage information can be displayed for any harness as in:
100+
101+
![Coverage information](../resources/screenshots/coverage-info.png)
102+
103+
To enable the coverage feature in the extension, toggle on the `Codelens-kani: Highlight Coverage` setting in `Settings > Extensions > Kani`.
104+
105+
#### View coverage information
106+
107+
Once the coverage feature is enabled, the `Get coverage info` action should be visible on top of each Kani harness in the project.
108+
Running the `Get coverage info` highlights all lines for which coverage information was obtained.
109+
110+
Coverage information (as described in the [RFC for line coverage](https://model-checking.github.io/kani/rfc/rfcs/0008-line-coverage.html#postprocessing-coverage-checks)) is represented with three colors:
111+
- **Green:** Indicates `FULL` coverage.
112+
- **Yellow:** Indicates `PARTIAL` coverage.
113+
- **Red:** Indicates `NONE` coverage.
114+
115+
**NOTE**: Line-based coverage information is an unstable feature.
31.6 KB
Loading

0 commit comments

Comments
 (0)