git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jeff King <peff@peff.net>
To: Chris Angelico <rosuav@gmail.com>
Cc: Kevin <ikke@ikke.info>, git <git@vger.kernel.org>
Subject: Re: Configuring a third-party git hook
Date: Thu, 20 Mar 2014 23:43:34 -0400	[thread overview]
Message-ID: <20140321034334.GA29683@sigill.intra.peff.net> (raw)
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).

> 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

  reply	other threads:[~2014-03-21  3:43 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-03-19 11:16 Configuring a third-party git hook Chris Angelico
2014-03-20 12:53 ` Kevin
2014-03-20 16:51   ` Chris Angelico
2014-03-20 23:38     ` Jeff King
2014-03-20 23:46       ` Chris Angelico
2014-03-21  3:43         ` Jeff King [this message]
2014-03-21  4:07           ` Chris Angelico
2014-03-21 17:31             ` Junio C Hamano
2014-03-21 17:48               ` Chris Angelico
2014-03-21 18:15               ` Jeff King
2014-03-21 18:53                 ` Junio C Hamano
2014-03-21 18:54                 ` Junio C Hamano
2014-03-20 16:53 ` Junio C Hamano
2014-03-20 17:10   ` Chris Angelico

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20140321034334.GA29683@sigill.intra.peff.net \
    --to=peff@peff.net \
    --cc=git@vger.kernel.org \
    --cc=ikke@ikke.info \
    --cc=rosuav@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).