summaryrefslogtreecommitdiff
path: root/CODING_STYLE
diff options
context:
space:
mode:
authorSven Eden <yamakuzure@gmx.net>2017-01-05 06:21:16 +0100
committerSven Eden <yamakuzure@gmx.net>2017-03-14 10:19:06 +0100
commitbd1ce0bdbfc97a958a6c56fe062bed892f08444a (patch)
tree3502a5dea91e7716d118492eddf6d660d7e36563 /CODING_STYLE
parentc4aaf34de5fb2aa0c9c8c4960b79ef34dd01f99e (diff)
Prep v226: Sync build files with upstream
Diffstat (limited to 'CODING_STYLE')
-rw-r--r--CODING_STYLE28
1 files changed, 9 insertions, 19 deletions
diff --git a/CODING_STYLE b/CODING_STYLE
index a96ddd359..f13f9becb 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