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

doc: Document rationale for using IWYU pragma: export

Browse Source
This commit is contained in:
Hennadii Stepanov
2026-03-13 12:54:18 +00:00
parent cfa3b10d50
commit 0fe6fccec2
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
doc/developer-notes.md
View File

@@ -542,6 +542,13 @@ to a function that accepts a `std::string` parameter. An implicit conversion occ
Use `IWYU pragma: export` very sparingly, as this enforces transitive inclusion of headers
and undermines the specific purpose of IWYU.
The acceptable cases for using `IWYU pragma: export` are:
1. Facade headers. For example, see [`compat/compat.h`](/src/compat/compat.h).
2. Drop-in replacement headers. For example, see [`util/time.h`](/src/util/time.h).
3. Presenting a complete interface across multiple headers.
A comment explaining the rationale is required for every use of `IWYU pragma: export`.
### Performance profiling with perf
Profiling is a good way to get a precise idea of where time is being spent in