Re: [PATCH 3/3] Documentation/clone: document ignored configuration variables
- Date: Thu, 15 Nov 2018 06:06:26 -0500
- From: Jeff King <peff@xxxxxxxx>
- Subject: Re: [PATCH 3/3] Documentation/clone: document ignored configuration variables
On Wed, Nov 14, 2018 at 11:46:20AM +0100, SZEDER Gábor wrote:
> Due to limitations in the current implementation, some configuration
> variables specified via 'git clone -c var=val' (or 'git -c var=val
> clone') are ignored during the initial fetch and checkout.
> Let the users know which configuration variables are known to be
> ignored ('remote.origin.mirror' and 'remote.origin.tagOpt') under the
> documentation of 'git clone -c', along with hints to use the options
> '--mirror' and '--no-tags' instead.
> diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
> index a55536f0bf..2fd12524f9 100644
> --- a/Documentation/git-clone.txt
> +++ b/Documentation/git-clone.txt
> @@ -189,6 +189,12 @@ objects from the source repository into a pack in the cloned repository.
> values are given for the same key, each value will be written to
> the config file. This makes it safe, for example, to add
> additional fetch refspecs to the origin remote.
> +Due to limitations of the current implementation, some configuration
> +variables do not take effect until after the initial fetch and checkout.
> +Configuration variables known to not take effect are:
> +`remote.<name>.mirror` and `remote.<name>.tagOpt`. Use the
> +corresponding `--mirror` and `--no-tags` options instead.
This looks good. I considered at first that this might want to go in a
BUGS section of the manpage, but it makes the most sense being right
next to the definition of "-c".