Re: [PATCH 2/3] sha1_name: get_sha1_with_context learns to follow symlinks

From: Junio C Hamano <gitster@pobox.com>
To: Eric Sunshine <sunshine@sunshineco.com>
Cc: David Turner <dturner@twopensource.com>,
	Git List <git@vger.kernel.org>,
	David Turner <dturner@twitter.com>
Subject: Re: [PATCH 2/3] sha1_name: get_sha1_with_context learns to follow symlinks
Date: Fri, 08 May 2015 13:25:45 -0700	[thread overview]
Message-ID: <xmqq6182ke9i.fsf@gitster.dls.corp.google.com> (raw)
In-Reply-To: <CAPc5daXmJSfdB_eyQ5ppVp2NhYGZvPChGAyn4p2hEde=4x9EEQ@mail.gmail.com> (Junio C. Hamano's message of "Fri, 8 May 2015 13:17:58 -0700")

Perhaps something like the attached patch is a good idea (I used
"BUG:" for now), I wonder?

 Documentation/CodingGuidelines | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index c6e536f..020370e 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -232,7 +232,12 @@ For C programs:
 	   to be translated, that follows immediately after it */
 	_("Here is a translatable string explained by the above.");
 
+ - Speaking of translations, do not mark the message to die() that
+   should never trigger unless there is an programming error.  E.g.
+
+	die("BUG: frotz() called with NULL pointer to xyzzy parameter");
+
- - Double negation is often harder to understand than no negation
+ - Double negation is not easier to understand than no negation
    at all.
 
  - There are two schools of thought when it comes to comparison,
