Details
- Reviewers
deadalnix - Group Reviewers
Restricted Project - Commits
- rSTAGING27763b4a2c6a: [DOC] Update developer notes
rABC27763b4a2c6a: [DOC] Update developer notes
Read the doc and try the instructions.
Diff Detail
- Repository
- rABC Bitcoin ABC
- Branch
- doc_developer_notes
- Lint
Lint Passed - Unit
No Test Coverage - Build Status
Buildable 9700 Build 17293: Default Diff Build & Tests Build 17292: arc lint + arc unit
Event Timeline
| doc/developer-notes.md | ||
|---|---|---|
| 392 ↗ | (On Diff #16686) | I literally have zero failure from ubsan. Is that necessary? |
| doc/developer-notes.md | ||
|---|---|---|
| 392 ↗ | (On Diff #16686) | The suppression list probably deserves an update, since it has been extracted from core some time ago. But there are cases that will only trigger with some compilers and compiler versions (e.g. there is a vptr reported in avalanche_tests with clang-7), so I'd better leave it to prevent people from facing issues. |
| doc/developer-notes.md | ||
|---|---|---|
| 364 ↗ | (On Diff #16686) | Why is debug necessary here? |
| doc/developer-notes.md | ||
|---|---|---|
| 364 ↗ | (On Diff #16686) | It is not necessary, but can help in having a better trace if an failure is triggered. |
| doc/developer-notes.md | ||
|---|---|---|
| 361 ↗ | (On Diff #16686) | IMO these could just be added by the sanitizer module to some place and the test module can query these. There is no reason for people to have to deal with this. |
| 392 ↗ | (On Diff #16686) | We already require clang format 8, and this is packaged in most distros. We don't support 7 and less. Backing old stuff in there is just asking for regressions. |
| doc/developer-notes.md | ||
|---|---|---|
| 244 ↗ | (On Diff #16686) | There is one target per test now and it can be used instead of this. |
| doc/developer-notes.md | ||
|---|---|---|
| 311 | Doesn't clang need to be used as well? My understanding is sanitizer support exists for gcc but we do not support it. | |
| doc/developer-notes.md | ||
|---|---|---|
| 311 | AFAIK both can work, it's more a matter of version. | |
Add a recommendation for using clang over gcc with sanitizers.
No clang version but "recent" in order to reduce maintenance of the doc.
Fix the suppression files path, actually make the paragraph look like a paragraph.
| doc/developer-notes.md | ||
|---|---|---|
| 332 ↗ | (On Diff #16747) | That's just what we are using on CI, as we had various issues with GCC in the past (I don't remember the details, I think there was some difference in the suppression file with some sanitizers, and some false positive on system libraries). |
| 381 ↗ | (On Diff #16747) | I agree it would be a good improvement, but it's non trivial and out of scope for this diff. |
| doc/developer-notes.md | ||
|---|---|---|
| 334 ↗ | (On Diff #16802) | I think this still need to be changed. This convey the idea that our goal is to be green in clang, whereas it is to be clean with gcc too. |