[docs] Add instructions for lcov report generation #11680

jamesob commented at 7:11 AM on November 14, 2017: member

After rediscovering the lcov report generation recipe one too many times, it seemed prudent to write some doc.

fanquake added the label Docs and Output on Nov 14, 2017

in doc/developer-notes.md:187 in 1e9b9923b5 outdated

 181 | @@ -182,6 +182,23 @@ $ valgrind --suppressions=contrib/valgrind.supp --leak-check=full \
 182 |  $ valgrind -v --leak-check=full src/bitcoind -printtoconsole
 183 |  ```
 184 |  
 185 | +**compiling for test coverage**
 186 | +
 187 | +Lcov can be used to generate a test coverage report based upon `make check`

promag commented at 2:19 PM on November 14, 2017:

Upper case LCOV.

in doc/developer-notes.md:188 in 1e9b9923b5 outdated

 181 | @@ -182,6 +182,23 @@ $ valgrind --suppressions=contrib/valgrind.supp --leak-check=full \
 182 |  $ valgrind -v --leak-check=full src/bitcoind -printtoconsole
 183 |  ```
 184 |  
 185 | +**compiling for test coverage**
 186 | +
 187 | +Lcov can be used to generate a test coverage report based upon `make check`
 188 | +execution. To enable lcov usage during test runs:

promag commented at 2:35 PM on November 14, 2017:

Same as above.

in doc/developer-notes.md:191 in 1e9b9923b5 outdated

 186 | +
 187 | +Lcov can be used to generate a test coverage report based upon `make check`
 188 | +execution. To enable lcov usage during test runs:
 189 | +
 190 | +```shell
 191 | +# Ensure `lcov` is installed on your system; e.g. on Debian this would be:

promag commented at 3:04 PM on November 14, 2017:

Remove comment? Just say lcov must be available/installed above.

in doc/developer-notes.md:201 in 1e9b9923b5 outdated

 196 | +make cov
 197 | +
 198 | +# A coverage report will now be accessible at `./test_bitcoin.coverage/index.html`.
 199 | +```
 200 | +
 201 | +

promag commented at 3:06 PM on November 14, 2017:

Remove 2nd empty line.

promag commented at 3:06 PM on November 14, 2017: member

Concept ACK.

MarcoFalke commented at 3:46 PM on November 14, 2017: member

utACK 1e9b9923b532219dc8002791b3fda0616ae5806d

fanquake commented at 11:17 PM on November 14, 2017: member

utACK after nits addressed

[docs] Add instructions for lcov coverage report generation 5ff01c2363

jamesob force-pushed on Nov 14, 2017

jamesob commented at 11:31 PM on November 14, 2017: member

@promag feedback incorporated; thanks.

fanquake commented at 1:34 AM on November 15, 2017: member

utACK 5ff01c2

jonasschnelli commented at 7:28 AM on November 15, 2017: contributor

Thanks. utACK 5ff01c236384c25ece31eba69f3718444cc2c599

jonasschnelli merged this on Nov 15, 2017

jonasschnelli closed this on Nov 15, 2017

jonasschnelli referenced this in commit 4db82b7aab on Nov 15, 2017

in doc/developer-notes.md:198 in 5ff01c2363

 193 | +```shell
 194 | +./configure --enable-lcov
 195 | +make
 196 | +make cov
 197 | +
 198 | +# A coverage report will now be accessible at `./test_bitcoin.coverage/index.html`.

promag commented at 7:38 AM on November 15, 2017:

Nit, could be out of code block.

promag commented at 7:38 AM on November 15, 2017: member

ACK.

PastaPastaPasta referenced this in commit 28cc559a20 on Jan 17, 2020

PastaPastaPasta referenced this in commit 4221199616 on Jan 22, 2020

PastaPastaPasta referenced this in commit bda1780a44 on Jan 22, 2020

PastaPastaPasta referenced this in commit 19b74203cf on Jan 29, 2020

PastaPastaPasta referenced this in commit 93edb6542e on Jan 29, 2020

PastaPastaPasta referenced this in commit 5bbbce30eb on Jan 29, 2020

ckti referenced this in commit d18f4a0279 on Mar 28, 2021

MarcoFalke locked this on Sep 8, 2021