X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=CODING_STYLE;h=598d241b2baa048c1bc18644ade20ea9dcfb3d49;hp=a3fc26c1e1b93e481a8e0ae077b2b92349316a1e;hb=9700d6980f7c212b10a69399e6430b82a6f45587;hpb=3fdbc8205885f117b7dea289b44217310663e731 diff --git a/CODING_STYLE b/CODING_STYLE index a3fc26c1e..598d241b2 100644 --- a/CODING_STYLE +++ b/CODING_STYLE @@ -18,7 +18,7 @@ - For robustness reasons, destructors should be able to destruct half-initialized objects, too -- Error codes are returned as negative Exxx. i.e. return -EINVAL. There +- Error codes are returned as negative Exxx. e.g. return -EINVAL. There are some exceptions: for constructors, it is OK to return NULL on OOM. For lookup functions, NULL is fine too for "not found". @@ -57,7 +57,7 @@ doing something wrong! - Stay uniform. For example, always use "usec_t" for time - values. Do not usec mix msec, and usec and whatnot. + values. Do not mix usec and msec, and usec and whatnot. - Make use of _cleanup_free_ and friends. It makes your code much nicer to read! @@ -79,6 +79,17 @@ But it is OK if you do not. +- Single-line "if" blocks should not be enclosed in {}. Use this: + + if (foobar) + waldo(); + + instead of this: + + if (foobar) { + waldo(); + } + - Do not write "foo ()", write "foo()". - Please use streq() and strneq() instead of strcmp(), strncmp() where applicable. @@ -155,7 +166,7 @@ function or a "non-logging" function. "Logging" functions do logging on their own, "non-logging" function never log on their own and expect their callers to log. All functions in "library" code, - i.e. in src/shared/ and suchlike must be "non-logging". Everytime a + i.e. in src/shared/ and suchlike must be "non-logging". Every time a "logging" function calls a "non-logging" function, it should log about the resulting errors. If a "logging" function calls another "logging" function, then it should not generate log messages, so