On Fri, Mar 21, 2014 at 10:38 AM, Jeff King <peff@xxxxxxxx> wrote: >> 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? .... 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. How does the attached patch look? ChrisA
From 1be7b0920510b9f45ca6d3879289753fdc5b5435 Mon Sep 17 00:00:00 2001 From: Chris Angelico <rosuav@xxxxxxxxx> Date: Fri, 21 Mar 2014 10:45:08 +1100 Subject: [PATCH] Explain that third-party tools may create 'git config' variables --- Documentation/config.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) 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. advice.*:: These variables control various optional help messages designed to -- 1.7.10.4