2005-09-08 02:26:23 +02:00
|
|
|
git-clone(1)
|
|
|
|
|
============
|
2005-07-14 05:25:54 +02:00
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
2007-06-09 17:44:12 +02:00
|
|
|
git-clone - Clone a repository into a new directory
|
2005-07-14 05:25:54 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
2005-12-31 18:37:15 +01:00
|
|
|
[verse]
|
2008-06-30 08:09:04 +02:00
|
|
|
'git clone' [--template=<template_directory>]
|
git-clone: aggressively optimize local clone behaviour.
This changes the behaviour of cloning from a repository on the
local machine, by defaulting to "-l" (use hardlinks to share
files under .git/objects) and making "-l" a no-op. A new
option, --no-hardlinks, is also added to cause file-level copy
of files under .git/objects while still avoiding the normal
"pack to pipe, then receive and index pack" network transfer
overhead. The old behaviour of local cloning without -l nor -s
is availble by specifying the source repository with the newly
introduced file:///path/to/repo.git/ syntax (i.e. "same as
network" cloning).
* With --no-hardlinks (i.e. have all .git/objects/ copied via
cpio) would not catch the source repository corruption, and
also risks corrupted recipient repository if an
alpha-particle hits memory cell while indexing and resolving
deltas. As long as the recipient is created uncorrupted, you
have a good back-up.
* same-as-network is expensive, but it would catch the breakage
of the source repository. It still risks corrupted recipient
repository due to hardware failure. As long as the recipient
is created uncorrupted, you have a good back-up.
* The new default on the same filesystem, as long as the source
repository is healthy, it is very likely that the recipient
would be, too. Also it is very cheap. You do not get any
back-up benefit, though.
None of the method is resilient against the source repository
corruption, so let's discount that from the comparison. Then
the difference with and without --no-hardlinks matters primarily
if you value the back-up benefit or not. If you want to use the
cloned repository as a back-up, then it is cheaper to do a clone
with --no-hardlinks and two git-fsck (source before clone,
recipient after clone) than same-as-network clone, especially as
you are likely to do a git-fsck on the recipient if you are so
paranoid anyway.
Which leads me to believe that being able to use file:/// is
probably a good idea, if only for testability, but probably of
little practical value. We default to hardlinked clone for
everyday use, and paranoids can use --no-hardlinks as a way to
make a back-up.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-02 08:42:36 +02:00
|
|
|
[-l] [-s] [--no-hardlinks] [-q] [-n] [--bare]
|
2006-05-28 19:14:38 +02:00
|
|
|
[-o <name>] [-u <upload-pack>] [--reference <repository>]
|
2007-11-01 15:21:39 +01:00
|
|
|
[--depth <depth>] [--] <repository> [<directory>]
|
2005-07-14 05:25:54 +02:00
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
2005-11-06 07:26:52 +01:00
|
|
|
|
2006-12-08 07:27:21 +01:00
|
|
|
Clones a repository into a newly created directory, creates
|
|
|
|
|
remote-tracking branches for each branch in the cloned repository
|
2007-01-06 02:52:20 +01:00
|
|
|
(visible using `git branch -r`), and creates and checks out an initial
|
|
|
|
|
branch equal to the cloned repository's currently active branch.
|
2005-11-06 07:26:52 +01:00
|
|
|
|
2006-12-08 07:27:21 +01:00
|
|
|
After the clone, a plain `git fetch` without arguments will update
|
|
|
|
|
all the remote-tracking branches, and a `git pull` without
|
|
|
|
|
arguments will in addition merge the remote master branch into the
|
2007-01-06 02:52:20 +01:00
|
|
|
current master branch, if any.
|
2005-11-06 07:26:52 +01:00
|
|
|
|
2006-12-08 07:27:21 +01:00
|
|
|
This default configuration is achieved by creating references to
|
|
|
|
|
the remote branch heads under `$GIT_DIR/refs/remotes/origin` and
|
|
|
|
|
by initializing `remote.origin.url` and `remote.origin.fetch`
|
|
|
|
|
configuration variables.
|
2005-07-14 05:25:54 +02:00
|
|
|
|
2007-01-02 00:08:06 +01:00
|
|
|
|
2005-07-14 05:25:54 +02:00
|
|
|
OPTIONS
|
|
|
|
|
-------
|
2005-10-02 21:42:57 +02:00
|
|
|
--local::
|
2005-07-14 05:25:54 +02:00
|
|
|
-l::
|
|
|
|
|
When the repository to clone from is on a local machine,
|
|
|
|
|
this flag bypasses normal "git aware" transport
|
|
|
|
|
mechanism and clones the repository by making a copy of
|
|
|
|
|
HEAD and everything under objects and refs directories.
|
git-clone: aggressively optimize local clone behaviour.
This changes the behaviour of cloning from a repository on the
local machine, by defaulting to "-l" (use hardlinks to share
files under .git/objects) and making "-l" a no-op. A new
option, --no-hardlinks, is also added to cause file-level copy
of files under .git/objects while still avoiding the normal
"pack to pipe, then receive and index pack" network transfer
overhead. The old behaviour of local cloning without -l nor -s
is availble by specifying the source repository with the newly
introduced file:///path/to/repo.git/ syntax (i.e. "same as
network" cloning).
* With --no-hardlinks (i.e. have all .git/objects/ copied via
cpio) would not catch the source repository corruption, and
also risks corrupted recipient repository if an
alpha-particle hits memory cell while indexing and resolving
deltas. As long as the recipient is created uncorrupted, you
have a good back-up.
* same-as-network is expensive, but it would catch the breakage
of the source repository. It still risks corrupted recipient
repository due to hardware failure. As long as the recipient
is created uncorrupted, you have a good back-up.
* The new default on the same filesystem, as long as the source
repository is healthy, it is very likely that the recipient
would be, too. Also it is very cheap. You do not get any
back-up benefit, though.
None of the method is resilient against the source repository
corruption, so let's discount that from the comparison. Then
the difference with and without --no-hardlinks matters primarily
if you value the back-up benefit or not. If you want to use the
cloned repository as a back-up, then it is cheaper to do a clone
with --no-hardlinks and two git-fsck (source before clone,
recipient after clone) than same-as-network clone, especially as
you are likely to do a git-fsck on the recipient if you are so
paranoid anyway.
Which leads me to believe that being able to use file:/// is
probably a good idea, if only for testability, but probably of
little practical value. We default to hardlinked clone for
everyday use, and paranoids can use --no-hardlinks as a way to
make a back-up.
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2007-08-02 08:42:36 +02:00
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
--no-hardlinks::
|
|
|
|
|
Optimize the cloning process from a repository on a
|
|
|
|
|
local filesystem by copying files under `.git/objects`
|
|
|
|
|
directory.
|
2005-07-14 05:25:54 +02:00
|
|
|
|
2005-10-02 21:42:57 +02:00
|
|
|
--shared::
|
|
|
|
|
-s::
|
|
|
|
|
When the repository to clone is on the local machine,
|
2005-11-06 07:26:52 +01:00
|
|
|
instead of using hard links, automatically setup
|
2006-04-19 02:19:48 +02:00
|
|
|
.git/objects/info/alternates to share the objects
|
2005-11-06 07:26:52 +01:00
|
|
|
with the source repository. The resulting repository
|
|
|
|
|
starts out without any object of its own.
|
2008-02-12 01:12:57 +01:00
|
|
|
+
|
|
|
|
|
*NOTE*: this is a possibly dangerous operation; do *not* use
|
|
|
|
|
it unless you understand what it does. If you clone your
|
2008-04-03 20:26:13 +02:00
|
|
|
repository using this option and then delete branches (or use any
|
|
|
|
|
other git command that makes any existing commit unreferenced) in the
|
|
|
|
|
source repository, some objects may become unreferenced (or dangling).
|
2008-06-30 20:56:34 +02:00
|
|
|
These objects may be removed by normal git operations (such as `git-commit`)
|
|
|
|
|
which automatically call `git gc --auto`. (See linkgit:git-gc[1].)
|
|
|
|
|
If these objects are removed and were referenced by the cloned repository,
|
|
|
|
|
then the cloned repository will become corrupt.
|
2008-01-22 23:12:25 +01:00
|
|
|
|
|
|
|
|
|
2005-10-02 21:42:57 +02:00
|
|
|
|
2006-04-19 02:19:48 +02:00
|
|
|
--reference <repository>::
|
|
|
|
|
If the reference repository is on the local machine
|
|
|
|
|
automatically setup .git/objects/info/alternates to
|
|
|
|
|
obtain objects from the reference repository. Using
|
|
|
|
|
an already existing repository as an alternate will
|
2007-09-07 18:43:37 +02:00
|
|
|
require fewer objects to be copied from the repository
|
2006-04-19 02:19:48 +02:00
|
|
|
being cloned, reducing network and local storage costs.
|
2008-04-03 20:26:13 +02:00
|
|
|
+
|
|
|
|
|
*NOTE*: see NOTE to --shared option.
|
2006-04-19 02:19:48 +02:00
|
|
|
|
2005-10-02 21:42:57 +02:00
|
|
|
--quiet::
|
2005-07-14 05:25:54 +02:00
|
|
|
-q::
|
|
|
|
|
Operate quietly. This flag is passed to "rsync" and
|
2008-06-30 20:56:34 +02:00
|
|
|
`git-fetch-pack` commands when given.
|
2005-07-14 05:25:54 +02:00
|
|
|
|
2007-07-13 01:54:07 +02:00
|
|
|
--no-checkout::
|
2005-10-02 21:42:57 +02:00
|
|
|
-n::
|
|
|
|
|
No checkout of HEAD is performed after the clone is complete.
|
|
|
|
|
|
2006-01-23 02:24:22 +01:00
|
|
|
--bare::
|
|
|
|
|
Make a 'bare' GIT repository. That is, instead of
|
2006-01-15 01:00:32 +01:00
|
|
|
creating `<directory>` and placing the administrative
|
|
|
|
|
files in `<directory>/.git`, make the `<directory>`
|
2006-11-23 23:58:35 +01:00
|
|
|
itself the `$GIT_DIR`. This obviously implies the `-n`
|
|
|
|
|
because there is nowhere to check out the working tree.
|
|
|
|
|
Also the branch heads at the remote are copied directly
|
|
|
|
|
to corresponding local branch heads, without mapping
|
|
|
|
|
them to `refs/remotes/origin/`. When this option is
|
2007-01-01 00:47:34 +01:00
|
|
|
used, neither remote-tracking branches nor the related
|
|
|
|
|
configuration variables are created.
|
2006-01-15 01:00:32 +01:00
|
|
|
|
2006-11-02 12:11:56 +01:00
|
|
|
--origin <name>::
|
2005-12-22 23:37:24 +01:00
|
|
|
-o <name>::
|
2007-01-01 00:47:34 +01:00
|
|
|
Instead of using the remote name 'origin' to keep track
|
|
|
|
|
of the upstream repository, use <name> instead.
|
2005-12-22 23:37:24 +01:00
|
|
|
|
2005-10-02 21:42:57 +02:00
|
|
|
--upload-pack <upload-pack>::
|
2005-07-14 05:25:54 +02:00
|
|
|
-u <upload-pack>::
|
|
|
|
|
When given, and the repository to clone from is handled
|
2008-06-30 20:56:34 +02:00
|
|
|
by `git-fetch-pack`, `--exec=<upload-pack>` is passed to
|
2005-07-14 05:25:54 +02:00
|
|
|
the command to specify non-default path for the command
|
|
|
|
|
run on the other end.
|
|
|
|
|
|
2006-05-28 19:14:38 +02:00
|
|
|
--template=<template_directory>::
|
|
|
|
|
Specify the directory from which templates will be used;
|
|
|
|
|
if unset the templates are taken from the installation
|
|
|
|
|
defined default, typically `/usr/share/git-core/templates`.
|
|
|
|
|
|
2007-02-19 13:35:35 +01:00
|
|
|
--depth <depth>::
|
2007-01-02 00:08:06 +01:00
|
|
|
Create a 'shallow' clone with a history truncated to the
|
2007-11-01 09:46:02 +01:00
|
|
|
specified number of revisions. A shallow repository has a
|
2007-01-02 00:08:06 +01:00
|
|
|
number of limitations (you cannot clone or fetch from
|
|
|
|
|
it, nor push from nor into it), but is adequate if you
|
2007-11-01 09:46:02 +01:00
|
|
|
are only interested in the recent history of a large project
|
|
|
|
|
with a long history, and would want to send in fixes
|
2007-01-02 00:08:06 +01:00
|
|
|
as patches.
|
|
|
|
|
|
2005-07-14 05:25:54 +02:00
|
|
|
<repository>::
|
2007-07-05 00:21:36 +02:00
|
|
|
The (possibly remote) repository to clone from. See the
|
|
|
|
|
<<URLS,URLS>> section below for more information on specifying
|
|
|
|
|
repositories.
|
2005-07-14 05:25:54 +02:00
|
|
|
|
|
|
|
|
<directory>::
|
2006-06-08 08:50:09 +02:00
|
|
|
The name of a new directory to clone into. The "humanish"
|
2005-11-10 12:58:08 +01:00
|
|
|
part of the source repository is used if no directory is
|
|
|
|
|
explicitly given ("repo" for "/path/to/repo.git" and "foo"
|
|
|
|
|
for "host.xz:foo/.git"). Cloning into an existing directory
|
|
|
|
|
is not allowed.
|
2005-11-06 07:26:52 +01:00
|
|
|
|
2007-11-16 19:43:16 +01:00
|
|
|
:git-clone: 1
|
2007-07-05 00:21:36 +02:00
|
|
|
include::urls.txt[]
|
|
|
|
|
|
2005-12-13 08:24:06 +01:00
|
|
|
Examples
|
2006-05-05 21:05:10 +02:00
|
|
|
--------
|
2005-12-13 08:24:06 +01:00
|
|
|
|
|
|
|
|
Clone from upstream::
|
|
|
|
|
+
|
|
|
|
|
------------
|
|
|
|
|
$ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
|
|
|
|
|
$ cd my2.6
|
|
|
|
|
$ make
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Make a local clone that borrows from the current directory, without checking things out::
|
|
|
|
|
+
|
|
|
|
|
------------
|
|
|
|
|
$ git clone -l -s -n . ../copy
|
2007-05-12 13:32:34 +02:00
|
|
|
$ cd ../copy
|
2005-12-13 08:24:06 +01:00
|
|
|
$ git show-branch
|
|
|
|
|
------------
|
|
|
|
|
|
2006-01-15 01:00:32 +01:00
|
|
|
|
2006-04-19 02:19:48 +02:00
|
|
|
Clone from upstream while borrowing from an existing local directory::
|
|
|
|
|
+
|
|
|
|
|
------------
|
|
|
|
|
$ git clone --reference my2.6 \
|
|
|
|
|
git://git.kernel.org/pub/scm/.../linux-2.7 \
|
|
|
|
|
my2.7
|
|
|
|
|
$ cd my2.7
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
|
2006-01-23 02:24:22 +01:00
|
|
|
Create a bare repository to publish your changes to the public::
|
2006-01-15 01:00:32 +01:00
|
|
|
+
|
|
|
|
|
------------
|
2006-01-23 02:24:22 +01:00
|
|
|
$ git clone --bare -l /home/proj/.git /pub/scm/proj.git
|
2006-01-15 01:00:32 +01:00
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Create a repository on the kernel.org machine that borrows from Linus::
|
|
|
|
|
+
|
|
|
|
|
------------
|
2006-01-23 02:24:22 +01:00
|
|
|
$ git clone --bare -l -s /pub/scm/.../torvalds/linux-2.6.git \
|
2006-01-15 01:00:32 +01:00
|
|
|
/pub/scm/.../me/subsys-2.6.git
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
|
2005-07-14 05:25:54 +02:00
|
|
|
Author
|
|
|
|
|
------
|
|
|
|
|
Written by Linus Torvalds <torvalds@osdl.org>
|
|
|
|
|
|
2005-12-13 08:24:06 +01:00
|
|
|
|
2005-07-14 05:25:54 +02:00
|
|
|
Documentation
|
|
|
|
|
--------------
|
2005-11-10 12:58:08 +01:00
|
|
|
Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
|
2005-07-14 05:25:54 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
GIT
|
|
|
|
|
---
|
2008-06-06 09:07:32 +02:00
|
|
|
Part of the linkgit:git[1] suite
|