diff options
| author | Jeff King <peff@peff.net> | 2012-05-30 11:09:08 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2012-05-30 16:51:14 (GMT) |
| commit | 9197a10c7188a74356384a7ce46e05104ac68240 (patch) | |
| tree | ff76eff29a6929706deb3e5b1f44e31b62b7cd1a /Documentation/git-clone.txt | |
| parent | 0680f745ac3322bd99653c3cbc1cd765ee0db5c0 (diff) | |
| download | git-9197a10c7188a74356384a7ce46e05104ac68240.zip git-9197a10c7188a74356384a7ce46e05104ac68240.tar.gz git-9197a10c7188a74356384a7ce46e05104ac68240.tar.bz2 | |
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>
Diffstat (limited to 'Documentation/git-clone.txt')
| -rw-r--r-- | Documentation/git-clone.txt | 17 |
1 files changed, 10 insertions, 7 deletions
diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 6e22522..1d267f4 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -46,13 +46,16 @@ OPTIONS mechanism and clones the repository by making a copy of HEAD and everything under objects and refs directories. The files under `.git/objects/` directory are hardlinked - to save space when possible. This is now the default when - the source repository is specified with `/path/to/repo` - syntax, so it essentially is a no-op option. To force - copying instead of hardlinking (which may be desirable - if you are trying to make a back-up of your repository), - but still avoid the usual "git aware" transport - mechanism, `--no-hardlinks` can be used. + to save space when possible. ++ +If the repository is specified as a local path (e.g., `/path/to/repo`), +this is the default, and --local is essentially a no-op. If the +repository is specified as a URL, then this flag is ignored (and we +never use the local optimizations). ++ +To force copying instead of hardlinking (which may be desirable if you +are trying to make a back-up of your repository), but still avoid the +usual "git aware" transport mechanism, `--no-hardlinks` can be used. --no-hardlinks:: Optimize the cloning process from a repository on a |