mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-02-20 14:05:23 +01:00
doc: Remove confusing assert linter
This commit is contained in:
parent
f5c5ddafbc
commit
fa6e6a3f03
2 changed files with 1 additions and 17 deletions
|
@ -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
|
||||
|
|
|
@ -23,20 +23,10 @@ def git_grep(params: [], error_msg: ""):
|
|||
|
||||
|
||||
def main():
|
||||
# PRE31-C (SEI CERT C Coding Standard):
|
||||
# "Assertions should not contain assignments, increment, or decrement operators."
|
||||
exit_code = git_grep([
|
||||
"-E",
|
||||
r"[^_]assert\(.*(\+\+|\-\-|[^=!<>]=[^=!<>]).*\);",
|
||||
"--",
|
||||
"*.cpp",
|
||||
"*.h",
|
||||
], "Assertions should not have side effects:")
|
||||
|
||||
# Aborting the whole process is undesirable for RPC code. So nonfatal
|
||||
# checks should be used over assert. See: src/util/check.h
|
||||
# src/rpc/server.cpp is excluded from this check since it's mostly meta-code.
|
||||
exit_code |= git_grep([
|
||||
exit_code = git_grep([
|
||||
"-nE",
|
||||
r"\<(A|a)ss(ume|ert) *\(.*\);",
|
||||
"--",
|
||||
|
|
Loading…
Add table
Reference in a new issue