From: Philip Oakley <philipoakley@iee.org>
Date: Mon, 16 Jun 2014 12:55:57 +0000 (+0100)
Subject: doc: give some guidelines for error messages
X-Git-Tag: v2.0.3~4^2
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=0ae0e882b2dd8048e2096138561f0b2ab0cad454;p=git

doc: give some guidelines for error messages

Clarify error message puntuation to reduce review workload.

Signed-off-by: Philip Oakley <philipoakley@iee.org>
Helped-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---

diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index f424dbd75c..f4137c68ff 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -264,6 +264,15 @@ For Python scripts:
    documentation for version 2.6 does not mention this prefix, it has
    been supported since version 2.6.0.
 
+Error Messages
+
+ - Do not end error messages with a full stop.
+
+ - Do not capitalize ("unable to open %s", not "Unable to open %s")
+
+ - Say what the error is first ("cannot open %s", not "%s: cannot open")
+
+
 Writing Documentation:
 
  Most (if not all) of the documentation pages are written in the