Permalink
Browse files

doc: instructions for generating coverage reports

Add instructions for generating code coverage reports to BUILDING.md

PR-URL: #15190
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information...
ssbrewster authored and MylesBorins committed Sep 4, 2017
1 parent 1b0e660 commit a260190717fcbdd39bd1e508c68e9be7669a990b
Showing with 19 additions and 0 deletions.
  1. +19 −0 BUILDING.md
View
@@ -129,6 +129,25 @@ To run the tests:
$ make test
```
To run the tests and generate code coverage reports:
```console
$ ./configure --coverage
$ make coverage
```
This will generate coverage reports for both JavaScript and C++ tests (if you
only want to run the JavaScript tests then you do not need to run the first
command `./configure --coverage`).
The `make coverage` command downloads some tools to the project root directory
and overwrites the `lib/` directory. To clean up after generating the coverage
reports:
```console
make coverage-clean
```
To build the documentation:
This will build Node.js first (if necessary) and then use it to build the docs:

0 comments on commit a260190

Please sign in to comment.