Re: Configuring a third-party git hook

From: Jeff King <peff@peff.net>
Date: Mar 20, 2014, 23:38 UTC
Message-ID: <20140320233816.GC7774@sigill.intra.peff.net>
In-Reply-To: <CAPTjJmpAcmVGgJK8iUvFuXJq_ZukisRZ6OD9TM=feuxDYm5iPQ@mail.gmail.com>

On Fri, Mar 21, 2014 at 03:51:16AM +1100, Chris Angelico wrote:

Show 15 quoted lines

> > 1. I would say yes. git config is made to be extended and doesn't
> > require a config item to be known.
> > 2. Namespacing the config items like you did is a good thing to do so
> > it won't interfere with other options.
> 
> Excellent! Thank you.
> 
> Is this documented anywhere? The git config man page says to look to
> other git man pages:
> 
> https://www.kernel.org/pub/software/scm/git/docs/git-config.html#_variables
> 
> A comment there to the effect that "Third party tools may also define
> their own variables" or something would make it clear that this is the
> intention.

I think this sentence from the section you linked is meant to express that:

  You will find a description of non-core porcelain configuration
  variables in the respective porcelain documentation.

but it is rather opaque, isn't it? You did not know it, but your hook is a non-core porcelain. :)

I think it could probably be re-worded, and possibly even indicate to authors of other programs that they are free to make up their own variables (but should take care with namespacing them appropriately).

Would you like to try your hand at writing a patch?

-Peff