diff options
| author | Benny Baumann <BenBE@geshi.org> | 2023-12-01 23:36:11 +0100 |
|---|---|---|
| committer | BenBE <BenBE@geshi.org> | 2023-12-26 15:14:19 +0100 |
| commit | cf9abeb695f2fb62bb27fd36f393e3216ab1927a (patch) | |
| tree | 5407b707d345dcb7d9762a202279e409c027abeb /docs | |
| parent | acb1ae4d29e694fe37f87aea073a38f04ced2a76 (diff) | |
Document compilation issues and changed config.h inclusion rules
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/styleguide.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/styleguide.md b/docs/styleguide.md index 82198f6b..92e69f5a 100644 --- a/docs/styleguide.md +++ b/docs/styleguide.md @@ -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 -------------- |