Re: [PATCH 2/2] transport-helper: mention helper name when it dies

From: Jeff King <peff@peff.net>
Date: Apr 10, 2013, 21:28 UTC
Message-ID: <20130410212833.GA5909@sigill.intra.peff.net>
In-Reply-To: <CAGdFq_j5vB+OJAkuk-EMLjyrbiY7QrBiwWPraPA7SWTtuUqgZA@mail.gmail.com>

On Wed, Apr 10, 2013 at 02:23:56PM -0700, Sverre Rabbelier wrote:

Show 17 quoted lines

> On Wed, Apr 10, 2013 at 2:16 PM, Jeff King <peff@peff.net> wrote:
> > When we try to read from a remote-helper and get EOF or an
> > error, we print a message indicating that the helper died.
> > However, users may not know that a remote helper was in use
> > (e.g., when using git-over-http), or even what a remote
> > helper is.
> >
> > Let's print the name of the helper (e.g., "git-remote-https");
> > this makes it more obvious what the program is for, and
> > provides a useful token for reporting bugs or searching for
> > more information (e.g., in manpages).
> >
> > Signed-off-by: Jeff King <peff@peff.net>
> 
> Better than nothing:
> 
> Acked-by: Sverre Rabbelier <srabbelier@gmail.com>

Now that's the kind of whole-hearted endorsement I strive for. :)

If you have better wording, I'm open to it. I do note that we don't actually have a manpage for "git-remote-https", though we do for others. Probably "man git-remote-helpers" is the most sensible thing to point the user to. But I don't even think this is worthy of a big advice message. It's a bug in the helper, it shouldn't really happen, and giving the user a token they can use to report or google for the error is probably good enough.

-Peff