diff options
author | Simon Brewster <ssbrewster@gmail.com> | 2017-09-05 00:10:05 +0200 |
---|---|---|
committer | James M Snell <jasnell@gmail.com> | 2017-09-06 22:13:00 -0700 |
commit | 6e27fd7bdeb60477d19c4d80dac57b002e6552e4 (patch) | |
tree | 599db258b763d03d8d71c4d2a807d3aebf1dbb76 /BUILDING.md | |
parent | 1df16c601a90059a1be1b819de14c5695120d88e (diff) | |
download | android-node-v8-6e27fd7bdeb60477d19c4d80dac57b002e6552e4.tar.gz android-node-v8-6e27fd7bdeb60477d19c4d80dac57b002e6552e4.tar.bz2 android-node-v8-6e27fd7bdeb60477d19c4d80dac57b002e6552e4.zip |
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>
Diffstat (limited to 'BUILDING.md')
-rw-r--r-- | BUILDING.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/BUILDING.md b/BUILDING.md index 805c89a3cd..8bf3d79cd5 100644 --- a/BUILDING.md +++ b/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: |