diff options
| author | fanquake <fanquake@gmail.com> | 2023-10-03 10:43:41 +0100 |
|---|---|---|
| committer | fanquake <fanquake@gmail.com> | 2023-10-03 10:44:21 +0100 |
| commit | 4e78834ec11ede578437e7a96bafd5542f26a9d5 (patch) | |
| tree | 6be2ac2309f914eaa4fa38ba97b216af75800805 /doc | |
| parent | 8113ac0ab4247c29c19746e4a0d03c07b31f0c09 (diff) | |
| parent | fa6e6a3f03a38f8b431bf694268ed344d1815b3b (diff) | |
Merge bitcoin/bitcoin#28304: doc: Remove confusing assert linter
fa6e6a3f03a38f8b431bf694268ed344d1815b3b doc: Remove confusing assert linter (MarcoFalke)
Pull request description:
The `assert()` documentation and linter are redundant and confusing:
* The source code already refuses to compile with `assert()` disabled.
* They violate the assumptions about `Assert()`, which *requires* side effects.
* The existing linter doesn't enforce the guideline, only checking for `++` and `--` side effects.
Fix all issues by removing the docs and the linter. See also https://github.com/bitcoin/bitcoin/pull/26684#discussion_r1287370102
Going forward everyone is free to use whatever code in this regard they think is the easiest to read. Also, everyone is still free to share style-nits, if they think it is a good use of their time and of the pull request author. Finally, the author is still free to dismiss or ignore this style-nit, or any other style-nit.
ACKs for top commit:
hebasto:
ACK fa6e6a3f03a38f8b431bf694268ed344d1815b3b, I have reviewed the code and it looks OK.
theStack:
ACK fa6e6a3f03a38f8b431bf694268ed344d1815b3b
Tree-SHA512: 686738d71e1316cc95e5d3f71869b55a02bfb137c795cc0875057f4410e564bc8eff03c985a2087b007fb08fc84551c7da1e8b30c7a9c3f2b14e5e44a5970236
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer-notes.md | 6 |
1 files changed, 0 insertions, 6 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 80353bcdd2..3c3f612053 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -739,12 +739,6 @@ Common misconceptions are clarified in those sections: - Passing (non-)fundamental types in the [C++ Core Guideline](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Rf-conventional). -- Assertions should not have side-effects. - - - *Rationale*: Even though the source code is set to refuse to compile - with assertions disabled, having side-effects in assertions is unexpected and - makes the code harder to understand. - - If you use the `.h`, you must link the `.cpp`. - *Rationale*: Include files define the interface for the code in implementation files. Including one but |