docs: Updated debug build instructions for cmake #30840

pull itornaza wants to merge 1 commits into bitcoin:master from itornaza:ion-developer-notes-1 changing 1 files +8 −2
  1. itornaza commented at 12:18 pm on September 7, 2024: contributor

    In the developer notes the section on compiling for debug displays outdated instructions that were applicable before the move to cmake build system.

    This PR just gives instructions on how to build for debugging in the context of cmake.

  2. DrahtBot commented at 12:18 pm on September 7, 2024: contributor

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

    Code Coverage

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

    Reviews

    See the guideline for information on the review process.

    Type Reviewers
    ACK tdb3, kevkevinpal, achow101

    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 7, 2024
  4. tdb3 commented at 5:05 pm on September 7, 2024: contributor

    Concept ACK

    Looks like the Win64 CI error is unrelated.

  5. DrahtBot added the label CI failed on Sep 7, 2024
  6. DrahtBot commented at 6:23 pm on September 7, 2024: contributor

    🚧 At least one of the CI tasks failed. Debug: https://github.com/bitcoin/bitcoin/runs/29818464464

    Make sure to run all tests locally, according to the documentation.

    The failure may happen due to a number of reasons, for example:

    • Possibly due to a silent merge conflict (the changes in this pull request being incompatible with the current code in the target branch). If so, make sure to rebase on the latest commit of the target branch.

    • A sanitizer issue, which can only be found by compiling with the sanitizer and running the affected test.

    • An intermittent issue.

    Leave a comment here, if you need help tracking down a confusing failure.

  7. docs: Updated debug build instructions for cmake 0b003e1ff7
  8. itornaza force-pushed on Sep 8, 2024
  9. DrahtBot removed the label CI failed on Sep 8, 2024
  10. itornaza commented at 5:21 pm on September 8, 2024: contributor
    Rebased to address the CI lint test error that was due to documentation lines terminating with whitespace characters.
  11. tdb3 approved
  12. tdb3 commented at 5:22 pm on September 8, 2024: contributor
    ACK 0b003e1ff7e09b56cd013b15f1998495994b7211
  13. kevkevinpal commented at 11:53 pm on September 10, 2024: contributor

    ACK 0b003e1

    Also in this parity list --enable-debug is replaced with -DCMAKE_BUILD_TYPE=Debug and defaults to RelWithDebInfo https://gist.github.com/hebasto/2ef97d3a726bfce08ded9df07f7dab5e

  14. itornaza commented at 10:27 am on September 11, 2024: contributor

    Also in this parity list --enable-debug is replaced with -DCMAKE_BUILD_TYPE=Debug and defaults to RelWithDebInfo https://gist.github.com/hebasto/2ef97d3a726bfce08ded9df07f7dab5e

    Very helpful link, thanks for sharing!

  15. achow101 commented at 5:19 pm on September 11, 2024: member

    ACK 0b003e1ff7e09b56cd013b15f1998495994b7211

    TIL ccmake.

  16. achow101 merged this on Sep 11, 2024
  17. achow101 closed this on Sep 11, 2024


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: 2024-12-26 21:12 UTC

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