Documentation/clone: document ignored configuration variables
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. Signed-off-by: SZEDER Gábor <szeder.dev@gmail.com> Reviewed-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
SZEDER Gábor committed
Nov 14, 2018 at 11:46 UTC
7eae4a3ac4084e6f01bbab2847a399ea5677a099
1 file changed
+6
Documentation/git-clone.txt
+6
@@ -189,6 +189,12 @@ objects from the source repository into a pack in the cloned repository.
189
values are given for the same key, each value will be written to
190
the config file. This makes it safe, for example, to add
191
additional fetch refspecs to the origin remote.
192
++
193
+Due to limitations of the current implementation, some configuration
194
+variables do not take effect until after the initial fetch and checkout.
195
+Configuration variables known to not take effect are:
196
+`remote.<name>.mirror` and `remote.<name>.tagOpt`. Use the
197
+corresponding `--mirror` and `--no-tags` options instead.
198
199
--depth <depth>::
200
Create a 'shallow' clone with a history truncated to the