doc: instructions for generating coverage reports

Add instructions for generating code coverage reports to BUILDING.md PR-URL: #15190 Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: James M Snell <[email protected]>
nodejs · Sep 26, 2017 · a260190 · a260190
1 parent 1b0e660
commit a260190
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/BUILDING.md b/BUILDING.md
@@ -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: