Add de-highlighting to coverage readme

model-checking · Sep 8, 2023 · fbeea67 · fbeea67
1 parent 6b863f6
commit fbeea67
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -18,6 +18,7 @@ Check [user guide](docs/user-guide.md) for more detailed information.
 -   One-click button for verifying Kani harnesses.
 -   Generate counterexamples as Rust unit tests.
 -   Debug counterexamples using a standard debugger.
+-   View coverage information inline using VS Code source highlighting.
 
 ## Requirements
 
@@ -32,7 +33,7 @@ NOTE: The extension only works on Cargo packages. For standalone Rust files, Kan
 | :-------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------- |
 | `kani.enable-codelens` | Enable Codelens actions for `Run Test (Kani)` & `Debug Test (Kani)`.                                                                                                      | `true`                                                         |
 | `kani.show-output-window`     | Toggle to show the output terminal window containing the full output from Kani.                                                                  | `false`                                                     |
-
+| `kani.highlight-coverage` | Toggle to enable the codelens button for `Generage Coverage` by default.  | `false`
 
 ## Installation
 

diff --git a/docs/user-guide.md b/docs/user-guide.md
@@ -113,3 +113,10 @@ Coverage information (as described in the [RFC for line coverage](https://model-
  - **Red:** Indicates `NONE` coverage.
 
 **NOTE**: Line-based coverage information is an unstable feature.
+
+
+#### De-highlight coverage information
+
+To remove or de-highlight the coverage information presented on the UI, open the command palette with `Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows/Linux). Then, search for the command `De-highlight coverage`. This should revert the VS Code UI to it's normal state (pre-coverage).
+
+![De-highlight command](../resources/screenshots/de-highlight.png)
diff --git a/resources/screenshots/de-highlight.png b/resources/screenshots/de-highlight.png