Skip to content

Commit

Permalink
Document compilation issues and changed config.h inclusion rules
Browse files Browse the repository at this point in the history
  • Loading branch information
BenBE committed Dec 26, 2023
1 parent acb1ae4 commit cf9abeb
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/styleguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,11 @@ The include list should be in the following order, with each group separated by
The list of headers should be sorted with includes from subdirectories following after files inside their parent directory.
Thus `unistd.h` sorts before `sys/time.h`.
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.
Failure to do so will cause a compilation error (sanity check inside `XUtils.h`) or may result in other, hard-to-debug compilation issues.
The include for `config.h` is only ever placed in the C source file and never in any header file.
For further details see PR #1337 in our issue tracker.
Symbol Exports
--------------
Expand Down

0 comments on commit cf9abeb

Please sign in to comment.