README: add a section for test coverage #704

1. 
   benma commented at 8:54 pm on December 29, 2019: contributor

   It is a hassle to figure out the exact commands to create a good report.
2. 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.
3. 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.
4. 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 think gcovr --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.
5. 
   real-or-random commented at 6:52 pm on December 30, 2019: contributor

   Thanks, that’s helpful.
6. real-or-random cross-referenced this on Jan 3, 2020 from issue WIP: Add gcov coverage report to Travis CI by real-or-random
7. benma force-pushed on Jan 3, 2020
8. benma force-pushed on Jan 3, 2020
9. 
   real-or-random commented at 3:17 pm on January 3, 2020: contributor

   ACK 75dd8f237f42d472854677dcbab2589383f88177
10. in 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.
11. 
    jonasnick commented at 12:27 pm on January 5, 2020: contributor

    This 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.”
12. README: add a section for test coverage

    It is a hassle to figure out the exact commands to create a good
    report.

    acb7f97eb8
13. benma force-pushed on Jan 15, 2020
14. 
    benma commented at 10:47 am on January 15, 2020: contributor

    This 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.

15. 
    real-or-random commented at 1:10 pm on January 15, 2020: contributor

    ACK acb7f97eb82dfbbdb797354e1550b910055b4422
16. 
    sipa commented at 3:55 pm on January 15, 2020: contributor

    ACK acb7f97eb82dfbbdb797354e1550b910055b4422
17. sipa referenced this in commit 074ab582dd on Jan 15, 2020
18. sipa merged this on Jan 15, 2020
19. sipa closed this on Jan 15, 2020

    ---

20. deadalnix referenced this in commit d4f3b32852 on Mar 2, 2020
21. deadalnix referenced this in commit f972edb25f on Mar 3, 2020
22. sickpig referenced this in commit c2429c7687 on Mar 24, 2020
23. sickpig referenced this in commit 9877389969 on Mar 24, 2020
24. ftrader referenced this in commit e941638c5c on May 19, 2020
25. sipa cross-referenced this on Jun 9, 2020 from issue Update libsecp256k1 subtree by sipa
26. fanquake referenced this in commit 8c97780db8 on Jun 13, 2020
27. sidhujag referenced this in commit 8a3a072968 on Jun 13, 2020
28. ComputerCraftr referenced this in commit b98f1c6e6c on Jun 16, 2020
29. UdjinM6 referenced this in commit 9d36ba6570 on Aug 10, 2021
30. 5tefan referenced this in commit 8ded2caa74 on Aug 12, 2021
31. gades referenced this in commit d855cc511d on May 8, 2022

Contributors
benma real-or-random jonasnick sipa