summaryrefslogtreecommitdiff
path: root/Documentation/CodingGuidelines
diff options
context:
space:
mode:
authorLars Schneider <larsxschneider@gmail.com>2016-02-25 08:42:22 (GMT)
committerJunio C Hamano <gitster@pobox.com>2016-02-25 20:49:45 (GMT)
commit658df95a4adb825f0c8a5faea7b545da6d1d5003 (patch)
tree7a1df49eaa3ccdf81c01399d1ffd1d1318fe3459 /Documentation/CodingGuidelines
parent48c39e98c6aff98b5dd165435373e517780302ad (diff)
downloadgit-658df95a4adb825f0c8a5faea7b545da6d1d5003.zip
git-658df95a4adb825f0c8a5faea7b545da6d1d5003.tar.gz
git-658df95a4adb825f0c8a5faea7b545da6d1d5003.tar.bz2
add DEVELOPER makefile knob to check for acknowledged warnings
We assume Git developers have a reasonably modern compiler and recommend them to enable the DEVELOPER makefile knob to ensure their patches are clear of all compiler warnings the Git core project cares about. Enable the DEVELOPER makefile knob in the Travis-CI build. Suggested-by: Jeff King <peff@peff.net> Signed-off-by: Lars Schneider <larsxschneider@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/CodingGuidelines')
-rw-r--r--Documentation/CodingGuidelines5
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index c6e536f..0ddd368 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -171,6 +171,11 @@ For C programs:
- We try to keep to at most 80 characters per line.
+ - As a Git developer we assume you have a reasonably modern compiler
+ and we recommend you to enable the DEVELOPER makefile knob to
+ ensure your patch is clear of all compiler warnings we care about,
+ by e.g. "echo DEVELOPER=1 >>config.mak".
+
- We try to support a wide range of C compilers to compile Git with,
including old ones. That means that you should not use C99
initializers, even if a lot of compilers grok it.