-
-
Notifications
You must be signed in to change notification settings - Fork 111
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
README: Document how to integrate with vscode
- Loading branch information
1 parent
1d04904
commit bf2c594
Showing
2 changed files
with
20 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
Integration with vscode | ||
----------------------- | ||
It's easy to produce output for parsing with the [coverage gutters](https://marketplace.visualstudio.com/items?itemName=ryanluker.vscode-coverage-gutters) | ||
extension to vscode. The `--cobertura-only` option is well-suited for this, which only outputs a | ||
`cov.xml` file and the coverage database in the output directory. Coverage information can then | ||
be directly shown in the "gutter" beside the editor, and is automatically updated by the | ||
extension when the coverage changes. | ||
|
||
To produce this output, just run | ||
|
||
``` | ||
kcov --cobertura-only [other options] /path/to/your/folder/.vscode /path/to/the/binary | ||
``` | ||
|
||
The coverage gutters extension looks for `cov.xml` files in the workspace, but for performance | ||
reasons, it's good to configure it to only look where the kcov output is (`.vscode`) in this | ||
example. |