Re: man git-config inconsistency (*.fsckObjects)

From: Jeff King <peff@peff.net>
Date: Feb 8, 2016, 18:41 UTC
Message-ID: <20160208184109.GA29332@sigill.intra.peff.net>
In-Reply-To: <CAPig+cQZ2LWsy1VC7Aqm+V3cWG7Y3rb0dGfyS_c3BCVM3Dekgw@mail.gmail.com>

On Mon, Feb 08, 2016 at 01:00:50PM -0500, Eric Sunshine wrote:

Show 13 quoted lines

> On Mon, Feb 8, 2016 at 10:08 AM, Jeff King <peff@peff.net> wrote:
> > On Mon, Feb 08, 2016 at 02:41:44PM +0000, Markus Kuhn wrote:
> >> Suggested rephrasing:
> >>
> >>            If not set, the value of transfer.fsckObjects is used
> >>            instead, which defaults to false.
> >
> > Yeah, I agree your phrasing is much clearer.
> 
> Should we worry about this becoming outdated if the default of
> transfer.fsckObjects ever changes, or is that being overcautious? If
> it is a legitimate concern, then perhaps drop "which defaults to
> false" from the end of the sentence.

I agree that is a potential maintenance pitfall, but I think it is outweighed by the benefit: namely that the information the user wants is right there, without them having to cross-reference themselves.

Flipping the default for transfer.fsckObjects would hopefully cause us to examine matching fetch.*, and we would notice this during review.

-Peff