Browse Source

doc: instructions for generating coverage reports

Add instructions for generating code coverage reports to BUILDING.md

PR-URL: https://github.com/nodejs/node/pull/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>
canary-base
Simon Brewster 7 years ago
committed by James M Snell
parent
commit
6e27fd7bde
  1. 19
      BUILDING.md

19
BUILDING.md

@ -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:

Loading…
Cancel
Save