highperfocused/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-07-12 06:50:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

doc: Remove dev note section on includes

Browse Source
This commit is contained in:
MarcoFalke
2025-05-20 18:27:22 +02:00
parent fa6623d85a
commit fad6cd739b
2 changed files with 4 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/developer-notes.md
View File

@ -1160,14 +1160,6 @@ namespace {
- *Rationale*: Avoids confusion about the namespace context. - *Rationale*: Avoids confusion about the namespace context.
- Use `#include <primitives/transaction.h>` bracket syntax instead of
`#include "primitives/transactions.h"` quote syntax.
- *Rationale*: Bracket syntax is less ambiguous because the preprocessor
searches a fixed list of include directories without taking location of the
source file into account. This allows quoted includes to stand out more when
the location of the source file actually is relevant.
- Use include guards to avoid the problem of double inclusion. The header file - Use include guards to avoid the problem of double inclusion. The header file
`foo/bar.h` should use the include guard identifier `BITCOIN_FOO_BAR_H`, e.g. `foo/bar.h` should use the include guard identifier `BITCOIN_FOO_BAR_H`, e.g.

4
test/lint/lint-includes.py
View File

@ -166,6 +166,10 @@ def main():
# Enforce bracket syntax includes # Enforce bracket syntax includes
quote_syntax_inclusions = find_quote_syntax_inclusions() quote_syntax_inclusions = find_quote_syntax_inclusions()
# *Rationale*: Bracket syntax is less ambiguous because the preprocessor
# searches a fixed list of include directories without taking location of the
# source file into account. This allows quoted includes to stand out more when
# the location of the source file actually is relevant.
if quote_syntax_inclusions: if quote_syntax_inclusions:
print("Please use bracket syntax includes (\"#include <foo.h>\") instead of quote syntax includes:") print("Please use bracket syntax includes (\"#include <foo.h>\") instead of quote syntax includes:")