doc: Clarify CMake test runner workflow in README #34123

pull YG01110 wants to merge 1 commits into bitcoin:master from YG01110:doc-clarify-cmake-run changing 1 files +6 −0
  1. YG01110 commented at 2:47 am on December 20, 2025: none

    This PR updates test/README.md to recommend running test_runner.py from the build/ directory when using CMake.

    Running from the source directory (e.g., ./test/functional/test_runner.py) fails on fresh builds because config.ini is located in the build directory. Using the build directory path leverages the symlinks correctly and ensures the configuration is found without needing manual flags.

    Context: Supersedes #34073 based on feedback from @maflcko.

  2. doc: Recommend running tests from build directory for CMake ac159aadac
  3. DrahtBot added the label Docs on Dec 20, 2025
  4. DrahtBot commented at 2:47 am on December 20, 2025: contributor

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

    Code Coverage & Benchmarks

    For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/34123.

    Reviews

    See the guideline for information on the review process. A summary of reviews will appear here.

  5. in test/README.md:73 in ac159aadac
    66@@ -67,6 +67,12 @@ Individual tests can be run by directly calling the test script, e.g.:
    67 build/test/functional/feature_rbf.py
    68 ```
    69 
    70+**Note for CMake users:** It is recommended to run the test runner from the build directory. This ensures the configuration file is loaded automatically via symlinks:
    71+
    72+```
    73+./build/test/functional/test_runner.py
    


    hebasto commented at 10:07 am on December 20, 2025:
    This has already been documented in README.md:https://github.com/bitcoin/bitcoin/blob/7f295e1d9b44c225c823242c1f04239f46fb27a6/README.md?plain=1#L54-L57
  6. YG01110 requested review from hebasto on Dec 20, 2025
  7. YG01110 closed this on Dec 20, 2025

  8. YG01110 commented at 11:46 am on December 20, 2025: none
    Closing this.
  9. YG01110 deleted the branch on Dec 20, 2025


YG01110 DrahtBot hebasto


hebasto

Labels
Docs


github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-01-02 15:13 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me