git/Documentation/CodingGuidelines, branch v2.9.2

doc: clearer rule about formatting literals

2016-06-08T19:04:37Z

Make the guideline text that we want for our documentation clearer. Signed-off-by: Tom Russello Signed-off-by: Erwan Mathoniere Signed-off-by: Samuel Groot Signed-off-by: Matthieu Moy Reviewed-by: Matthieu Moy Signed-off-by: Junio C Hamano

add DEVELOPER makefile knob to check for acknowledged warnings

2016-02-25T20:49:45Z

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 Signed-off-by: Lars Schneider Signed-off-by: Junio C Hamano

Merge branch 'jg/cguide-we-cannot-count'

2015-04-14T16:55:29Z

* jg/cguide-we-cannot-count: CodingGuidelines: update 'rough' rule count

CodingGuidelines: update 'rough' rule count

2015-04-14T16:50:31Z

Changed inaccurate count of "rough rules" from three to the more generic 'a few'. Signed-off-by: Julian Gindi Reviewed-by: Eric Sunshine Reviewed-by: Jonathan Nieder Signed-off-by: Junio C Hamano

*config.txt: stick to camelCase naming convention

2015-03-14T05:13:46Z

This should improve readability. Compare "thislongname" and "thisLongName". The following keys are left in unchanged. We can decide what to do with them later. - am.keepcr - core.autocrlf .safecrlf .trustctime - diff.dirstat .noprefix - gitcvs.usecrlfattr - gui.blamehistoryctx .trustmtime - pull.twohead - receive.autogc - sendemail.signedoffbycc .smtpsslcertpath .suppresscc Helped-by: Eric Sunshine Signed-off-by: Nguyễn Thái Ngọc Duy Signed-off-by: Eric Sunshine Signed-off-by: Junio C Hamano

Merge branch 'jc/conf-var-doc'

2015-02-22T20:28:31Z

Longstanding configuration variable naming rules has been added to the documentation. * jc/conf-var-doc: CodingGuidelines: describe naming rules for configuration variables config.txt: mark deprecated variables more prominently config.txt: clarify that add.ignore-errors is deprecated

Merge branch 'ah/usage-strings'

2015-02-11T21:44:20Z

* ah/usage-strings: standardize usage info string format

Merge branch 'jc/coding-guidelines'

2015-02-11T21:37:42Z

* jc/coding-guidelines: CodingGuidelines: clarify C #include rules

CodingGuidelines: describe naming rules for configuration variables

2015-02-02T19:28:55Z

We may want to say something about command line option names in the new section as well, but for now, let's make sure everybody is clear on how to structure and name their configuration variables. The text for the rules are partly taken from the log message of Jonathan's 6b3020a2 (add: introduce add.ignoreerrors synonym for add.ignore-errors, 2010-12-01). Signed-off-by: Junio C Hamano

CodingGuidelines: clarify C #include rules

2015-01-15T23:42:50Z

Even though "advice.h" includes "git-compat-util.h", it is not sensible to have it as the first #include and indirectly satisify the "You must give git-compat-util.h a clean environment to set up feature test macros before including any of the system headers are included", which is the real requirement. Because: - A command that interacts with the object store, config subsystem, the index, or the working tree cannot do anything without using what is declared in "cache.h"; - A built-in command must be declared in "builtin.h", so anything in builtin/*.c must include it; - These two headers both include "git-compat-util.h" as the first thing; and - Almost all our *.c files (outside compat/ and borrowed files in xdiff/) need some Git-ness from "cache.h" to do something Git-ish. let's explicitly specify that one of these three header files must be the first thing that is included. Any of our *.c file should include the header file that directly declares what it uses, instead of relying on the fact that some *.h file it includes happens to include another *.h file that declares the necessary function or type. Spell it out as another guideline item. Helped-by: Jeff King Signed-off-by: Junio C Hamano