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

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
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.
DrahtBot added the label Docs on Sep 11, 2024
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
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
kevkevinpal force-pushed on Sep 11, 2024
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
maflcko commented at 2:18 PM on September 11, 2024: member

review ACK 121dd14db40fa6bb6263fdea54d2f6be7b1f238e
DrahtBot commented at 2:19 PM on September 11, 2024: contributor


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

<details><summary>Hints</summary>

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.

</details>
DrahtBot added the label CI failed on Sep 11, 2024
docs: updated developer notes for --with-sanitizers to -DSANITIZERS and removed resource for -fsanitze flags 4b1ce3cac8
kevkevinpal force-pushed on Sep 11, 2024
kevkevinpal commented at 2:29 PM on September 11, 2024: contributor

sorry had a lint issue in commit

fixed lint issue in 4b1ce3c
maflcko commented at 2:42 PM on September 11, 2024: member

review ACK 4b1ce3cac81497dd094e8c34550edf633f4d38ae
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.
achow101 commented at 5:17 PM on September 11, 2024: member

ACK 4b1ce3cac81497dd094e8c34550edf633f4d38ae
achow101 merged this on Sep 11, 2024
achow101 closed this on Sep 11, 2024
TheCharlatan referenced this in commit 69282950aa on Sep 16, 2024
TheCharlatan referenced this in commit dfe0cd4ec5 on Sep 16, 2024
bitcoin locked this on Sep 11, 2025

Type	Reviewers
ACK	maflcko, pablomartin4btc, achow101

Contributors

Labels

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

Code Coverage

Reviews