Skip to content

Commit fad6cd7

Browse files
author
MarcoFalke
committed
doc: Remove dev note section on includes
1 parent fa6623d commit fad6cd7

File tree

2 files changed

+4
-8
lines changed

2 files changed

+4
-8
lines changed

doc/developer-notes.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1160,14 +1160,6 @@ namespace {
11601160

11611161
- *Rationale*: Avoids confusion about the namespace context.
11621162

1163-
- Use `#include <primitives/transaction.h>` bracket syntax instead of
1164-
`#include "primitives/transactions.h"` quote syntax.
1165-
1166-
- *Rationale*: Bracket syntax is less ambiguous because the preprocessor
1167-
searches a fixed list of include directories without taking location of the
1168-
source file into account. This allows quoted includes to stand out more when
1169-
the location of the source file actually is relevant.
1170-
11711163
- Use include guards to avoid the problem of double inclusion. The header file
11721164
`foo/bar.h` should use the include guard identifier `BITCOIN_FOO_BAR_H`, e.g.
11731165

test/lint/lint-includes.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,10 @@ def main():
166166

167167
# Enforce bracket syntax includes
168168
quote_syntax_inclusions = find_quote_syntax_inclusions()
169+
# *Rationale*: Bracket syntax is less ambiguous because the preprocessor
170+
# searches a fixed list of include directories without taking location of the
171+
# source file into account. This allows quoted includes to stand out more when
172+
# the location of the source file actually is relevant.
169173

170174
if quote_syntax_inclusions:
171175
print("Please use bracket syntax includes (\"#include <foo.h>\") instead of quote syntax includes:")

0 commit comments

Comments
 (0)