diff options
| author | Lennart Poettering <lennart@poettering.net> | 2015-09-06 01:30:08 +0200 |
|---|---|---|
| committer | Lennart Poettering <lennart@poettering.net> | 2015-09-06 01:30:08 +0200 |
| commit | 87766aa462f79cd70cc148fe293084dab68c7628 (patch) | |
| tree | 275fb0ee4ae6e4c4c77b9d6572c906a8c62658a6 | |
| parent | 718909ec33d15ddfb0eb2f1a504761a183fdf0db (diff) | |
| parent | 54c1f2d761b506132a709a7e8573c7b54d048cf0 (diff) | |
Merge pull request #1161 from dvdhrm/include-order2
CODING_STYLE: mandate alphabetical include order (v2)
| -rw-r--r-- | CODING_STYLE | 28 |
1 files changed, 9 insertions, 19 deletions
diff --git a/CODING_STYLE b/CODING_STYLE index a96ddd3598..f13f9becbc 100644 --- a/CODING_STYLE +++ b/CODING_STYLE @@ -295,25 +295,15 @@ EXIT_FAILURE and EXIT_SUCCESS as defined by libc. - The order in which header files are included doesn't matter too - much. However, please try to include the headers of external - libraries first (these are all headers enclosed in <>), followed by - the headers of our own public headers (these are all headers - starting with "sd-"), internal utility libraries from src/shared/, - followed by the headers of the specific component. Or in other - words: - - #include <stdio.h> - #include "sd-daemon.h" - #include "util.h" - #include "frobnicator.h" - - Where stdio.h is a public glibc API, sd-daemon.h is a public API of - our own, util.h is a utility library header from src/shared, and - frobnicator.h is an placeholder name for any systemd component. The - benefit of following this ordering is that more local definitions - are always defined after more global ones. Thus, our local - definitions will never "leak" into the global header files, possibly - altering their effect due to #ifdeffery. + much. systemd-internal headers must not rely on an include order, so + it is safe to include them in any order possible. + However, to not clutter global includes, and to make sure internal + definitions will not affect global headers, please always include the + headers of external components first (these are all headers enclosed + in <>), followed by our own exported headers (usually everything + that's prefixed by "sd-"), and then followed by internal headers. + Furthermore, in all three groups, order all includes alphabetically + so duplicate includes can easily be detected. - To implement an endless loop, use "for (;;)" rather than "while (1)". The latter is a bit ugly anyway, since you probably really |