README: add a section for test coverage #704
pull benma wants to merge 1 commits into bitcoin-core:master from benma:readme-coverage changing 1 files +21 −0-
benma commented at 8:54 pm on December 29, 2019: contributorIt is a hassle to figure out the exact commands to create a good report.
-
in README.md:83 in 840320cd8f outdated
76@@ -77,6 +77,21 @@ With valgrind, you might need to increase the max stack size: 77 78 $ valgrind --max-stackframe=2500000 ./exhaustive_tests 79 80+Test coverage 81+----------- 82+ 83+To create a test coverage report, configure with `--enable-coverage`:
real-or-random commented at 6:50 pm on December 30, 2019:Can you add that GCC is necessary?
benma commented at 1:00 pm on January 3, 2020:Done.in README.md:85 in 840320cd8f outdated
76@@ -77,6 +77,21 @@ With valgrind, you might need to increase the max stack size: 77 78 $ valgrind --max-stackframe=2500000 ./exhaustive_tests 79 80+Test coverage 81+----------- 82+ 83+To create a test coverage report, configure with `--enable-coverage`: 84+ 85+ $ ./configure --enable-coverage=yes
real-or-random commented at 6:50 pm on December 30, 2019:0 $ ./configure --enable-coverage
is enough.
benma commented at 1:00 pm on January 3, 2020:Done.in README.md:97 in 840320cd8f outdated
88+ 89+ $ make check 90+ 91+To create a HTML report, `gcovr` is recommended, as it visualizes the coverage of all branches: 92+ 93+ $ gcovr -r . --html --html-details -o coverage.html
real-or-random commented at 6:51 pm on December 30, 2019:Since we’re on the command line anyway, I thinkgcovr --exclude 'src/bench*' --print-summary
is a better option.
benma commented at 1:01 pm on January 3, 2020:Added, but also kept the HTML anyways, since I mainly use this one to check which lines are not covered.real-or-random commented at 6:52 pm on December 30, 2019: contributorThanks, that’s helpful.real-or-random cross-referenced this on Jan 3, 2020 from issue WIP: Add gcov coverage report to Travis CI by real-or-randombenma force-pushed on Jan 3, 2020benma force-pushed on Jan 3, 2020real-or-random commented at 3:17 pm on January 3, 2020: contributorACK 75dd8f237f42d472854677dcbab2589383f88177in README.md:91 in 75dd8f237f outdated
86+ 87+Run the tests: 88+ 89+ $ make check 90+ 91+To create a report, `gcovr` is recommended, as it includes the coverage of all branches:
jonasnick commented at 12:22 pm on January 5, 2020:nit: s/coverage of all branches/branch coverage reporting
benma commented at 10:46 am on January 15, 2020:Done.jonasnick commented at 12:27 pm on January 5, 2020: contributorThis section would fit better into the README if we’d add a sentence like “This library aims to have full coverage of the reachable lines and branches.”README: add a section for test coverage
It is a hassle to figure out the exact commands to create a good report.
benma force-pushed on Jan 15, 2020benma commented at 10:47 am on January 15, 2020: contributorThis section would fit better into the README if we’d add a sentence like “This library aims to have full coverage of the reachable lines and branches.”
Also added.
real-or-random commented at 1:10 pm on January 15, 2020: contributorACK acb7f97eb82dfbbdb797354e1550b910055b4422sipa commented at 3:55 pm on January 15, 2020: contributorACK acb7f97eb82dfbbdb797354e1550b910055b4422sipa referenced this in commit 074ab582dd on Jan 15, 2020sipa merged this on Jan 15, 2020sipa closed this on Jan 15, 2020
deadalnix referenced this in commit d4f3b32852 on Mar 2, 2020deadalnix referenced this in commit f972edb25f on Mar 3, 2020sickpig referenced this in commit c2429c7687 on Mar 24, 2020sickpig referenced this in commit 9877389969 on Mar 24, 2020ftrader referenced this in commit e941638c5c on May 19, 2020sipa cross-referenced this on Jun 9, 2020 from issue Update libsecp256k1 subtree by sipafanquake referenced this in commit 8c97780db8 on Jun 13, 2020sidhujag referenced this in commit 8a3a072968 on Jun 13, 2020ComputerCraftr referenced this in commit b98f1c6e6c on Jun 16, 2020UdjinM6 referenced this in commit 9d36ba6570 on Aug 10, 20215tefan referenced this in commit 8ded2caa74 on Aug 12, 2021gades referenced this in commit d855cc511d on May 8, 2022
github-metadata-mirror
This is a metadata mirror of the GitHub repository bitcoin-core/secp256k1. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2024-10-30 03:15 UTC
This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me