doc: unit test runner help fixup and improvements #30890

1. 
   jonatack commented at 6:56 PM on September 12, 2024: member

   Running test_bitcoin --help prints the list of arguments that may be passed, not the list of tests, so fix that.

   Improve the content and order of the unit test documentation.

2. 
   DrahtBot commented at 6:57 PM on September 12, 2024: contributor

   <!--e57a25ab6845829454e8d69fc972939a-->

   The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

   <!--006a51241073e994b41acfe9ec718e94-->

   Code Coverage

   For detailed information about the code coverage, see the test coverage report.

   <!--021abf342d371248e50ceaed478a90ca-->

   Reviews

   See the guideline for information on the review process.

   Type	Reviewers
   ACK	pablomartin4btc, tdb3
   Stale ACK	jarolrod, maflcko

   If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

3. DrahtBot added the label Docs on Sep 12, 2024
4. in src/test/README.md:100 in 03c48f95bb outdated

     96 | @@ -97,7 +97,7 @@ If you run an entire test suite, such as `--run_test=getarg_tests`, or all the t
     97 |  (by not specifying `--run_test`), a separate directory
     98 |  will be created for each individual test.
     99 |  
    100 | -Run `test_bitcoin --help` for the full list of tests.
    101 | +Run `test_bitcoin --help` for the full list of arguments that can be passed.
   

   ---

   ---

   

   jarolrod commented at 9:14 PM on September 12, 2024:

   This does change the help to be accurate to what the help command does.

5. in src/test/README.md:47 in 0024d2c6ea outdated

     39 | -For example, to run just the `getarg_tests` suite of tests:
     40 | +The `test_bitcoin` runner accepts command line arguments from the Boost
     41 | +framework. To see the list of arguments that may be passed, run:
     42 | +
     43 | +```
     44 | +test_bitcoin --help
   

   ---

   ---

   

   jarolrod commented at 9:34 PM on September 12, 2024:

   agree this is most helpful here

6. jarolrod approved
7. 
   jarolrod commented at 9:35 PM on September 12, 2024: member

   ACK 0024d2c6ea0fafe9b9949af4bbcd0c583e580746

8. 
   pablomartin4btc commented at 9:50 AM on September 13, 2024: member

   ACK 0024d2c6ea0fafe9b9949af4bbcd0c583e580746

   nit: maybe you can add "Run test_bitcoin --list_content for the full list of tests." in the previous section "Compiling/running unit tests", before the paragraph starting with "To run the unit tests manually,..".

9. 
   fanquake commented at 9:52 AM on September 13, 2024: member

   Can probably squash, given the single line changed in the first commit, is then deleted/moved in the second commit.

10. tdb3 approved
11. 
    tdb3 commented at 11:15 AM on September 13, 2024: contributor

    ACK 0024d2c6ea0fafe9b9949af4bbcd0c583e580746

    Useful doc improvements, thanks.

12. 
    maflcko commented at 12:36 PM on September 13, 2024: member

    review ACK 0024d2c6ea0fafe9b9949af4bbcd0c583e580746

13. jonatack force-pushed on Sep 13, 2024
14. jonatack renamed this:
    doc: unit test runner help fixup
    doc: unit test runner help fixup and improvements
    on Sep 13, 2024
15. 
    jonatack commented at 2:53 PM on September 13, 2024: member

    Thanks everyone, updated to take all feedback.

16. tdb3 approved
17. 
    tdb3 commented at 2:54 PM on September 13, 2024: contributor

    re ACK 44caadd83dbc612f41c70baaea3055c52f27df90

18. DrahtBot requested review from maflcko on Sep 13, 2024
19. DrahtBot requested review from pablomartin4btc on Sep 13, 2024
20. DrahtBot requested review from jarolrod on Sep 13, 2024
21. Unit test runner documentation fix and improvements

    - Running `test_bitcoin --help` prints the list of arguments that may be passed,
      not the list of tests, so fix that.
    
    - Improve the content and order of the unit test documentation.

    282f0e9255
22. jonatack force-pushed on Sep 13, 2024
23. 
    jonatack commented at 2:56 PM on September 13, 2024: member

    (Thanks @tdb3, repushed to put the text suggested by @pablomartin4btc in the right place.)

24. pablomartin4btc approved
25. 
    pablomartin4btc commented at 3:06 PM on September 13, 2024: member

    re-ACK 282f0e92559da23e356504a564a0322b9888e50b

    Thanks!

26. DrahtBot requested review from tdb3 on Sep 13, 2024
27. tdb3 approved
28. 
    tdb3 commented at 3:11 PM on September 13, 2024: contributor

    re ACK 282f0e92559da23e356504a564a0322b9888e50b

    Latest change is moving the line about --list-content

29. fanquake merged this on Sep 13, 2024
30. fanquake closed this on Sep 13, 2024

    ---

31. jonatack deleted the branch on Sep 13, 2024
32. TheCharlatan referenced this in commit 69282950aa on Sep 16, 2024
33. TheCharlatan referenced this in commit dfe0cd4ec5 on Sep 16, 2024
34. bitcoin locked this on Sep 13, 2025

Contributors

jonatackDrahtBotjarolrodpablomartin4btcfanquaketdb3maflcko

Review Requested
maflckojarolrod