MinGW: avoid collisions between "tags" and "TAGS"
[git/dscho.git] / Documentation / CodingGuidelines
blob8346c1972be24abf4e4269b9171a0eb456c2895a
1 Like other projects, we also have some guidelines to keep to the
2 code.  For git in general, three rough rules are:
4  - Most importantly, we never say "It's in POSIX; we'll happily
5    ignore your needs should your system not conform to it."
6    We live in the real world.
8  - However, we often say "Let's stay away from that construct,
9    it's not even in POSIX".
11  - In spite of the above two rules, we sometimes say "Although
12    this is not in POSIX, it (is so convenient | makes the code
13    much more readable | has other good characteristics) and
14    practically all the platforms we care about support it, so
15    let's use it".
17    Again, we live in the real world, and it is sometimes a
18    judgement call, the decision based more on real world
19    constraints people face than what the paper standard says.
22 As for more concrete guidelines, just imitate the existing code
23 (this is a good guideline, no matter which project you are
24 contributing to). It is always preferable to match the _local_
25 convention. New code added to git suite is expected to match
26 the overall style of existing code. Modifications to existing
27 code is expected to match the style the surrounding code already
28 uses (even if it doesn't match the overall style of existing code).
30 But if you must have a list of rules, here they are.
32 For shell scripts specifically (not exhaustive):
34  - We prefer $( ... ) for command substitution; unlike ``, it
35    properly nests.  It should have been the way Bourne spelled
36    it from day one, but unfortunately isn't.
38  - We use ${parameter-word} and its [-=?+] siblings, and their
39    colon'ed "unset or null" form.
41  - We use ${parameter#word} and its [#%] siblings, and their
42    doubled "longest matching" form.
44  - We use Arithmetic Expansion $(( ... )).
46  - Inside Arithmetic Expansion, spell shell variables with $ in front
47    of them, as some shells do not grok $((x)) while accepting $(($x))
48    just fine (e.g. dash older than 0.5.4).
50  - No "Substring Expansion" ${parameter:offset:length}.
52  - No shell arrays.
54  - No strlen ${#parameter}.
56  - No regexp ${parameter/pattern/string}.
58  - We do not use Process Substitution <(list) or >(list).
60  - We prefer "test" over "[ ... ]".
62  - We do not write the noiseword "function" in front of shell
63    functions.
65  - As to use of grep, stick to a subset of BRE (namely, no \{m,n\},
66    [::], [==], nor [..]) for portability.
68    - We do not use \{m,n\};
70    - We do not use -E;
72    - We do not use ? nor + (which are \{0,1\} and \{1,\}
73      respectively in BRE) but that goes without saying as these
74      are ERE elements not BRE (note that \? and \+ are not even part
75      of BRE -- making them accessible from BRE is a GNU extension).
77 For C programs:
79  - We use tabs to indent, and interpret tabs as taking up to
80    8 spaces.
82  - We try to keep to at most 80 characters per line.
84  - When declaring pointers, the star sides with the variable
85    name, i.e. "char *string", not "char* string" or
86    "char * string".  This makes it easier to understand code
87    like "char *string, c;".
89  - We avoid using braces unnecessarily.  I.e.
91         if (bla) {
92                 x = 1;
93         }
95    is frowned upon.  A gray area is when the statement extends
96    over a few lines, and/or you have a lengthy comment atop of
97    it.  Also, like in the Linux kernel, if there is a long list
98    of "else if" statements, it can make sense to add braces to
99    single line blocks.
101  - We try to avoid assignments inside if().
103  - Try to make your code understandable.  You may put comments
104    in, but comments invariably tend to stale out when the code
105    they were describing changes.  Often splitting a function
106    into two makes the intention of the code much clearer.
108  - Double negation is often harder to understand than no negation
109    at all.
111  - Some clever tricks, like using the !! operator with arithmetic
112    constructs, can be extremely confusing to others.  Avoid them,
113    unless there is a compelling reason to use them.
115  - Use the API.  No, really.  We have a strbuf (variable length
116    string), several arrays with the ALLOC_GROW() macro, a
117    string_list for sorted string lists, a hash map (mapping struct
118    objects) named "struct decorate", amongst other things.
120  - When you come up with an API, document it.
122  - The first #include in C files, except in platform specific
123    compat/ implementations, should be git-compat-util.h or another
124    header file that includes it, such as cache.h or builtin.h.
126  - If you are planning a new command, consider writing it in shell
127    or perl first, so that changes in semantics can be easily
128    changed and discussed.  Many git commands started out like
129    that, and a few are still scripts.
131  - Avoid introducing a new dependency into git. This means you
132    usually should stay away from scripting languages not already
133    used in the git core command set (unless your command is clearly
134    separate from it, such as an importer to convert random-scm-X
135    repositories to git).
137  - When we pass <string, length> pair to functions, we should try to
138    pass them in that order.