all repos — openbox @ 98c5205b9ef8ee9f11bc8912ad8b09f756036e77

openbox fork - make it a bit more like ryudo

Update HACKING for brace rules

The rules in HACKING for braces are kind of unclear, so add some
more rules and provide examples too.
Dana Jansens danakj@orodu.net
commit

98c5205b9ef8ee9f11bc8912ad8b09f756036e77

parent

f4bad155be02782eea690bf60d025358da2a8570

1 files changed, 34 insertions(+), 4 deletions(-)

jump to
M HACKINGHACKING

@@ -23,11 +23,41 @@ For openbox, we aim to have consistent coding style. Some, but surely

not all, guidelines: * use 4 space indents * tabs should not appear in source files - * functions should have the opening and closing braces on their own - lines - * most other constructs should have braces on the same line as the - statement + * closing braces always go on a new line + * for functions, the opening brace goes on a new line + void foo() + { + hi; + } + * for control blocks, the opening brace goes on the same line as the + condition, unless the condition spans more than one line. then the brace + goes on a new line. + if (one line) { + hi; + } + if (first line && + second line) + { + hi; + } * else appears on a new line, just like an if + if (testing) { + hi; + } + else if (other) { + bye; + } + * always use braces around conditional blocks that consist of more than one + line, even if they contain a single statement + if (check) { + /* Check was true. */ + yay = true(ok, + thanks); + } + * don't need to use braces for conditional blocks that use only a single + line, including comments. + if (check) + all_on_one_line_so_no_braces_needed(); * when in doubt look at the rest of the source * vim users can use "set expandtab tabstop=4 shiftwidth=4 softtabstop=4" for some of this