Skip to content

Commit cf9abeb

Browse files
committed
Document compilation issues and changed config.h inclusion rules
1 parent acb1ae4 commit cf9abeb

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/styleguide.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,11 @@ The include list should be in the following order, with each group separated by
7575
The list of headers should be sorted with includes from subdirectories following after files inside their parent directory.
7676
Thus `unistd.h` sorts before `sys/time.h`.
7777
78+
When `XUtils.h` is used by the module itself or any of its included headers, the C source file must include `config.h` in the manner noted above.
79+
Failure to do so will cause a compilation error (sanity check inside `XUtils.h`) or may result in other, hard-to-debug compilation issues.
80+
The include for `config.h` is only ever placed in the C source file and never in any header file.
81+
For further details see PR #1337 in our issue tracker.
82+
7883
Symbol Exports
7984
--------------
8085

0 commit comments

Comments
 (0)