delta/git.git/Documentation/CodingGuidelines, branch jc/conf-var-doc

CodingGuidelines: describe naming rules for configuration variables

2015-02-02T19:28:55+00:00

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

Merge branch 'po/error-message-style'

2014-07-16T18:33:03+00:00

* po/error-message-style:
  doc: give some guidelines for error messages

doc: give some guidelines for error messages

2014-07-10T20:31:55+00:00

Clarify error message puntuation to reduce review workload.

Signed-off-by: Philip Oakley 
Helped-by: Jeff King 
Signed-off-by: Junio C Hamano

CodingGuidelines: avoid "test -a/-o "

2014-05-20T18:19:43+00:00

The construct is error-prone; "test" being built-in in most modern
shells, the reason to avoid "test  && test " spawning
one extra process by using a single "test  -a " no
longer exists.

Signed-off-by: Junio C Hamano

CodingGuidelines: on splitting a long line

2014-05-02T21:08:16+00:00

Signed-off-by: Junio C Hamano

CodingGuidelines: on comparison

2014-05-02T20:44:46+00:00

There are arguments for writing a conditional as "a < b" rather than
"b > a", or vice versa.  Let's give guidance on which we prefer.

See http://thread.gmane.org/gmane.comp.version-control.git/3903/focus=4126
for the original discussion.

Signed-off-by: Junio C Hamano

CodingGuidelines: do not call the conditional statement "if()"

2014-05-02T20:26:07+00:00

The point immediately before it is about having SP after the control
keyword.  Spell it out as 'an "if" statement' instead.

Signed-off-by: Junio C Hamano

CodingGuidelines: give an example for shell function preamble

2014-05-02T20:24:57+00:00

Signed-off-by: Junio C Hamano

CodingGuidelines: give an example for control statements

2014-05-02T20:24:57+00:00

Signed-off-by: Junio C Hamano

CodingGuidelines: give an example for redirection

2014-05-02T20:24:57+00:00

Signed-off-by: Junio C Hamano