Skip to content

Commit

Permalink
doc: instructions for generating coverage reports
Browse files Browse the repository at this point in the history
Add instructions for generating code coverage reports to BUILDING.md

PR-URL: nodejs#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 addaleax committed Sep 13, 2017
1 parent ff3e592 commit 4869daf
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,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:
Expand Down

0 comments on commit 4869daf

Please sign in to comment.