[PATCH (v2)] Mention "local convention" rule in the CodingGuidelines
From: Nanako Shiraishi <hidden>
Date: 2016-06-15 22:46:02
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
The document suggests to imitate the existing code, but didn't say which existing code it should imitate. This clarifies. Signed-off-by: しらいしななこ <redacted> --- Quoting Junio C Hamano [off-list ref]:
It is always preferable to match the _local_ convention. I'd expect a new script added to git suite to match my preference (the one I showed you in my comments to you that is used in git-am, which is what you suggested above), but I'd expect a modification to mergetool to match the style mergetool already uses.
Sverre fixed some typo for me. Documentation/CodingGuidelines | 9 +++++++-- 1 files changed, 7 insertions(+), 2 deletions(-)
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index f628c1f..664c6c2 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):
--
Nanako Shiraishi
http://ivory.ap.teacup.com/nanako3/