X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2FCodingGuidelines;h=f628c1f3b7b706f9d585b96041e5a4b12bc0f62c;hb=2b6a5417d750d086d1da906e46de2b3ad8df6753;hp=994eb9159a2b0e8a10f4f9510165d420004203bf;hpb=998b912927281a871e8d379e2b3a4385c775c4fe;p=git.git diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 994eb9159..f628c1f3b 100644 --- a/Documentation/CodingGuidelines +++ b/Documentation/CodingGuidelines @@ -89,6 +89,8 @@ For C programs: of "else if" statements, it can make sense to add braces to single line blocks. + - We try to avoid assignments inside if(). + - Try to make your code understandable. You may put comments in, but comments invariably tend to stale out when the code they were describing changes. Often splitting a function @@ -103,7 +105,7 @@ For C programs: - Use the API. No, really. We have a strbuf (variable length string), several arrays with the ALLOC_GROW() macro, a - path_list for sorted string lists, a hash map (mapping struct + string_list for sorted string lists, a hash map (mapping struct objects) named "struct decorate", amongst other things. - When you come up with an API, document it.