X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=CODING_STYLE;h=557401348789e0322ea45a1d699d56430da329eb;hp=598d241b2baa048c1bc18644ade20ea9dcfb3d49;hb=754061ce7173fd8cb66ade1a48381e2cead35522;hpb=61f33134fc9231e07e1b9519b140d68139e9fad0

diff --git a/CODING_STYLE b/CODING_STYLE
index 598d241b2..557401348 100644
--- a/CODING_STYLE
+++ b/CODING_STYLE
@@ -1,4 +1,5 @@
-- 8ch indent, no tabs
+- 8ch indent, no tabs, except for files in man/ which are 2ch indent,
+  and still no tabs
 
 - Don't break code lines too eagerly. We do *not* force line breaks at
   80ch, all of today's screens should be much larger than that. But
@@ -182,7 +183,28 @@
   is_main_thread() to detect whether the calling thread is the main
   thread.
 
-- Option parsing:
+- Command line option parsing:
   - Do not print full help() on error, be specific about the error.
   - Do not print messages to stdout on error.
   - Do not POSIX_ME_HARDER unless necessary, i.e. avoid "+" in option string.
+
+- Do not write functions that clobber call-by-reference variables on
+  failure. Use temporary variables for these cases and change the
+  passed in variables only on success.
+
+- When you allocate a file descriptor, it should be made O_CLOEXEC
+  right from the beginning, as none of our files should leak to forked
+  binaries by default. Hence, whenever you open a file, O_CLOEXEC must
+  be specified, right from the beginning. This also applies to
+  sockets. Effectively this means that all invocations to:
+
+  a) open() must get O_CLOEXEC passed
+  b) socket() and socketpair() must get SOCK_CLOEXEC passed
+  c) recvmsg() must get MSG_CMSG_CLOEXEC set
+  d) F_DUPFD_CLOEXEC should be used instead of F_DUPFD, and so on
+
+- We never use the XDG version of basename(). glibc defines it in
+  libgen.h. The only reason to include that file is because dirname()
+  is needed. Everytime you need that please immediately undefine
+  basename(), and add a comment about it, so that no code ever ends up
+  using the XDG version!