docs: updated developer notes for –with-sanitizers to -DSANITIZERS #30870

pull kevkevinpal wants to merge 1 commits into bitcoin:master from kevkevinpal:withSanatizersFlag changing 1 files +4 −5
  1. kevkevinpal commented at 1:31 pm on September 11, 2024: contributor
    In the developer notes we are incorrectly using the Autotools --with-sanitizers configure flag which we should now be using cmake -B build -DSANITIZERS=<values> instead now
  2. DrahtBot commented at 1:32 pm on September 11, 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 maflcko, pablomartin4btc, 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 11, 2024
  4. in doc/developer-notes.md:1 in 80af4b327f


    maflcko commented at 1:58 pm on September 11, 2024:
    unrelated nit in the same section: I think * [Issue [#12691](/bitcoin-bitcoin/12691/): Enable -fsanitize flags in Travis](https://github.com/bitcoin/bitcoin/issues/12691) can be removed. Not sure why it would be important or relevant to read today.

    kevkevinpal commented at 2:02 pm on September 11, 2024:
    agreed, I remove it in this commit 12f9d33
  5. maflcko commented at 2:03 pm on September 11, 2024: member
    I think a 4-line doc fixup can be a single commit. Please squash your commits according to https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits
  6. kevkevinpal force-pushed on Sep 11, 2024
  7. kevkevinpal commented at 2:16 pm on September 11, 2024: contributor

    I think a 4-line doc fixup can be a single commit. Please squash your commits according to https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md#squashing-commits

    no problem squashed into 121dd14

  8. maflcko commented at 2:18 pm on September 11, 2024: member
    review ACK 121dd14db40fa6bb6263fdea54d2f6be7b1f238e
  9. DrahtBot commented at 2:19 pm on September 11, 2024: contributor

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

    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.

  10. DrahtBot added the label CI failed on Sep 11, 2024
  11. docs: updated developer notes for --with-sanitizers to -DSANITIZERS and removed resource for -fsanitze flags 4b1ce3cac8
  12. kevkevinpal force-pushed on Sep 11, 2024
  13. kevkevinpal commented at 2:29 pm on September 11, 2024: contributor

    sorry had a lint issue in commit

    fixed lint issue in 4b1ce3c

  14. maflcko commented at 2:42 pm on September 11, 2024: member
    review ACK 4b1ce3cac81497dd094e8c34550edf633f4d38ae
  15. pablomartin4btc commented at 4:10 pm on September 11, 2024: member

    ACK 4b1ce3cac81497dd094e8c34550edf633f4d38ae

    nit: if you have to retouch, commit title looks too long and prefix is doc usually.

  16. achow101 commented at 5:17 pm on September 11, 2024: member
    ACK 4b1ce3cac81497dd094e8c34550edf633f4d38ae
  17. achow101 merged this on Sep 11, 2024
  18. 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-09-28 22:12 UTC

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