summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorLibravatar Nanako Shiraishi <nanako3@lavabit.com>2009-01-26 17:32:22 +0900
committerLibravatar Junio C Hamano <gitster@pobox.com>2009-01-26 00:35:58 -0800
commitdfb047b9e4f7f66c5322ef642f21fd92b0a975e3 (patch)
treee5ea82273dcfa42b767cfdf121db2c8207f84224 /Documentation
parentMerge git://git.bogomips.org/git-svn (diff)
downloadtgif-dfb047b9e4f7f66c5322ef642f21fd92b0a975e3.tar.xz
Mention "local convention" rule in the CodingGuidelines
The document suggests to imitate the existing code, but didn't say which existing code it should imitate. This clarifies. Signed-off-by: しらいしななこ <nanako3@lavabit.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/CodingGuidelines9
1 files changed, 7 insertions, 2 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index f628c1f3b7..0d7fa9cca9 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -21,8 +21,13 @@ code. For git in general, three rough rules are:
As for more concrete guidelines, just imitate the existing code
(this is a good guideline, no matter which project you are
-contributing to). But if you must have a list of rules,
-here they are.
+contributing to). It is always preferable to match the _local_
+convention. New code added to git suite is expected to match
+the overall style of existing code. Modifications to existing
+code is expected to match the style the surrounding code already
+uses (even if it doesn't match the overall style of existing code).
+
+But if you must have a list of rules, here they are.
For shell scripts specifically (not exhaustive):