docs/clone: mention that --local may be ignored
The --local flag is not "treat this like a local repository", but rather "if we are local, turn on optimizations". Therefore it does nothing in the case of: git clone --local file:///path/to/repo Let's make that more clear in the documentation. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jeff King committed
May 30, 2012 at 07:09 UTC
9197a10c7188a74356384a7ce46e05104ac68240
1 file changed
+10
-7
Documentation/git-clone.txt
+10
-7
@@ -46,13 +46,16 @@ OPTIONS
46
mechanism and clones the repository by making a copy of
47
HEAD and everything under objects and refs directories.
48
The files under `.git/objects/` directory are hardlinked
49
- to save space when possible. This is now the default when
50
- the source repository is specified with `/path/to/repo`
51
- syntax, so it essentially is a no-op option. To force
52
- copying instead of hardlinking (which may be desirable
53
- if you are trying to make a back-up of your repository),
54
- but still avoid the usual "git aware" transport
55
- mechanism, `--no-hardlinks` can be used.
49
+ to save space when possible.
50
++
51
+If the repository is specified as a local path (e.g., `/path/to/repo`),
52
+this is the default, and --local is essentially a no-op. If the
53
+repository is specified as a URL, then this flag is ignored (and we
54
+never use the local optimizations).
55
++
56
+To force copying instead of hardlinking (which may be desirable if you
57
+are trying to make a back-up of your repository), but still avoid the
58
+usual "git aware" transport mechanism, `--no-hardlinks` can be used.
59
60
--no-hardlinks::
61
Optimize the cloning process from a repository on a