Re: [PATCHv4 2/2] Documentation/clone: document ignored configuration variables
- From
Jonathan Nieder <jrnieder@gmail.com>
- Date
- Jun 13, 2017, 23:24 UTC
- Message-ID
- <20170613232407.GQ133952@aiede.mtv.corp.google.com>
- In-Reply-To
- <20170530071244.32257-2-szeder.dev@gmail.com>
Hi,
SZEDER Gábor wrote:
Show 12 quoted lines
> Due to limitations/bugs 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'.
>
> Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com>
> ---
> Documentation/git-clone.txt | 4 ++++
> 1 file changed, 4 insertions(+)Makes sense.
Show 13 quoted lines
> diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt > index ec41d3d69..4f1e7d4ba 100644 > --- a/Documentation/git-clone.txt > +++ b/Documentation/git-clone.txt > @@ -186,6 +186,10 @@ 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. > + Note that due to limitations of the current implementation some > + configuration variables don't take effect during the initial > + fetch and checkout. Configuration variables known to not take > + effect are: `remote.<name>.mirror` and `remote.<name>.tagOpt`. >
Tiny nit: the paragraph of --config description is already a bit overwhelming, and I think this additional note takes it over the edge where I give up and stop reading. Could it go in a separate paragraph?
the config file. This makes it safe, for example, to add additional fetch refspecs to the origin remote. + Due to limitations in the current implementation, some configuration variables do not take effect until after the initial fetch and checkout. Configuration variables known not to take effect are `remote.<name>.mirror` and `remote.<name>.tagOpt`.
Thanks, Jonathan