Browse Source

[PATCH] Update git-clone documentation

The documentation for git-clone is behind the actual command.
I have been getting tired of reading the shell script to see
what the arguments are so here is an update of the actual documentation.

Signed-off-by: Eric Biederman <ebiederman@xmission.com>
Signed-off-by: Junio C Hamano <junkio@cox.net>
maint
Eric W. Biederman 20 years ago committed by Junio C Hamano
parent
commit
a2775c2a41
  1. 15
      Documentation/git-clone.txt

15
Documentation/git-clone.txt

@ -9,7 +9,7 @@ git-clone - Clones a repository.


SYNOPSIS SYNOPSIS
-------- --------
'git clone' [-l] [-u <upload-pack>] [-q] <repository> <directory> 'git clone' [-l [-s]] [-q] [-n] [-u <upload-pack>] <repository> <directory>


DESCRIPTION DESCRIPTION
----------- -----------
@ -17,6 +17,7 @@ Clones a repository into a newly created directory.


OPTIONS OPTIONS
------- -------
--local::
-l:: -l::
When the repository to clone from is on a local machine, When the repository to clone from is on a local machine,
this flag bypasses normal "git aware" transport this flag bypasses normal "git aware" transport
@ -25,10 +26,22 @@ OPTIONS
The files under .git/objects/ directory are hardlinked The files under .git/objects/ directory are hardlinked
to save space when possible. to save space when possible.


--shared::
-s::
When the repository to clone is on the local machine,
instead of using hard links automatically setup
.git/objects/info/alternatives to share the objects
with the source repository

--quiet::
-q:: -q::
Operate quietly. This flag is passed to "rsync" and Operate quietly. This flag is passed to "rsync" and
"git-clone-pack" commands when given. "git-clone-pack" commands when given.


-n::
No checkout of HEAD is performed after the clone is complete.

--upload-pack <upload-pack>::
-u <upload-pack>:: -u <upload-pack>::
When given, and the repository to clone from is handled When given, and the repository to clone from is handled
by 'git-clone-pack', '--exec=<upload-pack>' is passed to by 'git-clone-pack', '--exec=<upload-pack>' is passed to

Loading…
Cancel
Save