diff --git a/doc/developer-notes.md b/doc/developer-notes.md index ff6300cc08c..b9965b4f4d3 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -1160,14 +1160,6 @@ namespace { - *Rationale*: Avoids confusion about the namespace context. -- Use `#include ` 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 `foo/bar.h` should use the include guard identifier `BITCOIN_FOO_BAR_H`, e.g. diff --git a/test/lint/lint-includes.py b/test/lint/lint-includes.py index 05780c30746..b0c91b90114 100755 --- a/test/lint/lint-includes.py +++ b/test/lint/lint-includes.py @@ -166,6 +166,10 @@ def main(): # Enforce bracket syntax includes 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: print("Please use bracket syntax includes (\"#include \") instead of quote syntax includes:")