Re: Configuring a third-party git hook

From: Jeff King <peff@peff.net>
Date: Mar 21, 2014, 03:43 UTC
Message-ID: <20140321034334.GA29683@sigill.intra.peff.net>
In-Reply-To: <CAPTjJmpYREHy1cufZMuyOoXrO1Oy7QwXR+wBvm9cbgkT7SqC4Q@mail.gmail.com>

On Fri, Mar 21, 2014 at 10:46:15AM +1100, Chris Angelico wrote:

> .... oohhhhhh. Heh. I thought the "porcelain" sections of git were the
> lower-level or machine-readable versions of other tools, and didn't
> really think of mine as fitting into that.

The term sometimes gets used confusingly. The "plumbing" is the low-level stuff that supports the "porcelain", that users interact with. But sometimes options to produce low-level scriptable output get called "--porcelain", as in "this is the output to be used when building a porcelain on top".

Calling a hook script "porcelain" is kind of stretching it, I think, but it is filling the same role (it is software built on top of git, and using git to store config options).

Show 13 quoted lines

> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index 73c8973..23f0466 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -131,8 +131,9 @@ Variables
>  
>  Note that this list is non-comprehensive and not necessarily complete.
>  For command-specific variables, you will find a more detailed description
> -in the appropriate manual page. You will find a description of non-core
> -porcelain configuration variables in the respective porcelain documentation.
> +in the appropriate manual page. Other git-related tools may define their own
> +variables, which will be defined on their respective manual pages; ideally,
> +these will be named in some way to indicate the project or creator.

Thanks, the new text looks good to me. Please follow SubmittingPatches (notably, you need to sign-off your work, and please send patches inline rather than as attachments).

-Peff