clone: do not let --depth imply --shallow-submodules
[git/git.git] / Documentation / git-clone.txt
CommitLineData
215a7ad1
JH
1git-clone(1)
2============
6ec311da
JH
3
4NAME
5----
29cf5e12 6git-clone - Clone a repository into a new directory
6ec311da
JH
7
8
9SYNOPSIS
10--------
353ce815 11[verse]
b1889c36 12'git clone' [--template=<template_directory>]
bc699afc 13 [-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [--mirror]
db9bc00e 14 [-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>]
fb1d6dab 15 [--dissociate] [--separate-git-dir <git dir>]
3e6e0edd 16 [--depth <depth>] [--[no-]single-branch]
d22eb044
SB
17 [--recursive | --recurse-submodules] [--[no-]shallow-submodules]
18 [--jobs <n>] [--] <repository> [<directory>]
6ec311da
JH
19
20DESCRIPTION
21-----------
4607166d 22
db9819a4
BF
23Clones a repository into a newly created directory, creates
24remote-tracking branches for each branch in the cloned repository
33405be3
JN
25(visible using `git branch -r`), and creates and checks out an
26initial branch that is forked from the cloned repository's
27currently active branch.
4607166d 28
db9819a4
BF
29After the clone, a plain `git fetch` without arguments will update
30all the remote-tracking branches, and a `git pull` without
31arguments will in addition merge the remote master branch into the
31b808a0
RT
32current master branch, if any (this is untrue when "--single-branch"
33is given; see below).
4607166d 34
db9819a4 35This default configuration is achieved by creating references to
cc1b8d8b 36the remote branch heads under `refs/remotes/origin` and
db9819a4
BF
37by initializing `remote.origin.url` and `remote.origin.fetch`
38configuration variables.
6ec311da 39
f4bf2184 40
6ec311da
JH
41OPTIONS
42-------
a2775c2a 43--local::
6ec311da
JH
44-l::
45 When the repository to clone from is on a local machine,
2de9b711 46 this flag bypasses the normal "Git aware" transport
6ec311da
JH
47 mechanism and clones the repository by making a copy of
48 HEAD and everything under objects and refs directories.
3d5c418f 49 The files under `.git/objects/` directory are hardlinked
9197a10c
JK
50 to save space when possible.
51+
52If the repository is specified as a local path (e.g., `/path/to/repo`),
53this is the default, and --local is essentially a no-op. If the
54repository is specified as a URL, then this flag is ignored (and we
189260b1
JK
55never use the local optimizations). Specifying `--no-local` will
56override the default when `/path/to/repo` is given, using the regular
2de9b711 57Git transport instead.
3d5c418f
JH
58
59--no-hardlinks::
897e3e45
ALI
60 Force the cloning process from a repository on a local
61 filesystem to copy the files under the `.git/objects`
62 directory instead of using hardlinks. This may be desirable
63 if you are trying to make a back-up of your repository.
6ec311da 64
a2775c2a
EB
65--shared::
66-s::
67 When the repository to clone is on the local machine,
4607166d 68 instead of using hard links, automatically setup
550c66f3 69 `.git/objects/info/alternates` to share the objects
4607166d
JH
70 with the source repository. The resulting repository
71 starts out without any object of its own.
84668872
MV
72+
73*NOTE*: this is a possibly dangerous operation; do *not* use
74it unless you understand what it does. If you clone your
2498a1ad 75repository using this option and then delete branches (or use any
2de9b711 76other Git command that makes any existing commit unreferenced) in the
2498a1ad 77source repository, some objects may become unreferenced (or dangling).
2de9b711 78These objects may be removed by normal Git operations (such as `git commit`)
483bc4f0
JN
79which automatically call `git gc --auto`. (See linkgit:git-gc[1].)
80If these objects are removed and were referenced by the cloned repository,
81then the cloned repository will become corrupt.
13354f53
JK
82+
83Note that running `git repack` without the `-l` option in a repository
84cloned with `-s` will copy objects from the source repository into a pack
85in the cloned repository, removing the disk space savings of `clone -s`.
86It is safe, however, to run `git gc`, which uses the `-l` option by
87default.
88+
89If you want to break the dependency of a repository cloned with `-s` on
90its source repository, you can simply run `git repack -a` to copy all
91objects from the source repository into a pack in the cloned repository.
a2775c2a 92
23edecbc 93--reference <repository>::
40592376 94 If the reference repository is on the local machine,
550c66f3 95 automatically setup `.git/objects/info/alternates` to
23edecbc
SP
96 obtain objects from the reference repository. Using
97 an already existing repository as an alternate will
451e5931 98 require fewer objects to be copied from the repository
23edecbc 99 being cloned, reducing network and local storage costs.
2498a1ad 100+
fb1d6dab
JH
101*NOTE*: see the NOTE for the `--shared` option, and also the
102`--dissociate` option.
103
104--dissociate::
105 Borrow the objects from reference repositories specified
106 with the `--reference` options only to reduce network
0181681e
AR
107 transfer, and stop borrowing from them after a clone is made
108 by making necessary local copies of borrowed objects. This
109 option can also be used when cloning locally from a
110 repository that already borrows objects from another
111 repository--the new repository will borrow objects from the
112 same repository, and this option can be used to stop the
113 borrowing.
23edecbc 114
a2775c2a 115--quiet::
6ec311da 116-q::
488c3163
TRC
117 Operate quietly. Progress is not reported to the standard
118 error stream. This flag is also passed to the `rsync'
d3296e37 119 command when given.
6ec311da 120
21188b1e
MV
121--verbose::
122-v::
c54b74af
TRC
123 Run verbosely. Does not affect the reporting of progress status
124 to the standard error stream.
5a518ad4
TRC
125
126--progress::
488c3163
TRC
127 Progress status is reported on the standard error stream
128 by default when it is attached to a terminal, unless -q
129 is specified. This flag forces progress status even if the
130 standard error stream is not directed to a terminal.
21188b1e 131
fd0368f9 132--no-checkout::
a2775c2a
EB
133-n::
134 No checkout of HEAD is performed after the clone is complete.
135
87e80c4b 136--bare::
48a8c26c 137 Make a 'bare' Git repository. That is, instead of
8a1a120c
JH
138 creating `<directory>` and placing the administrative
139 files in `<directory>/.git`, make the `<directory>`
71821351
PB
140 itself the `$GIT_DIR`. This obviously implies the `-n`
141 because there is nowhere to check out the working tree.
142 Also the branch heads at the remote are copied directly
143 to corresponding local branch heads, without mapping
144 them to `refs/remotes/origin/`. When this option is
36566cc0
BF
145 used, neither remote-tracking branches nor the related
146 configuration variables are created.
8a1a120c 147
bc699afc 148--mirror::
6db2103f
UKK
149 Set up a mirror of the source repository. This implies `--bare`.
150 Compared to `--bare`, `--mirror` not only maps local branches of the
151 source to local branches of the target, it maps all refs (including
29b9a66f 152 remote-tracking branches, notes etc.) and sets up a refspec configuration such
6db2103f
UKK
153 that all these refs are overwritten by a `git remote update` in the
154 target repository.
bc699afc 155
ba158a32 156--origin <name>::
e6c310fd 157-o <name>::
550c66f3
BG
158 Instead of using the remote name `origin` to keep track
159 of the upstream repository, use `<name>`.
e6c310fd 160
7a4ee28f
JK
161--branch <name>::
162-b <name>::
163 Instead of pointing the newly created HEAD to the branch pointed
550c66f3 164 to by the cloned repository's HEAD, point to `<name>` branch
31b808a0
RT
165 instead. In a non-bare repository, this is the branch that will
166 be checked out.
167 `--branch` can also take tags and detaches the HEAD at that commit
168 in the resulting repository.
7a4ee28f 169
a2775c2a 170--upload-pack <upload-pack>::
6ec311da 171-u <upload-pack>::
d3296e37
SH
172 When given, and the repository to clone from is accessed
173 via ssh, this specifies a non-default path for the command
6ec311da
JH
174 run on the other end.
175
a57c8bac
JH
176--template=<template_directory>::
177 Specify the directory from which templates will be used;
d8a8488d 178 (See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
a57c8bac 179
84054f79
JK
180--config <key>=<value>::
181-c <key>=<value>::
182 Set a configuration variable in the newly-created repository;
183 this takes effect immediately after the repository is
184 initialized, but before the remote history is fetched or any
185 files checked out. The key is in the same format as expected by
186 linkgit:git-config[1] (e.g., `core.eol=true`). If multiple
187 values are given for the same key, each value will be written to
188 the config file. This makes it safe, for example, to add
189 additional fetch refspecs to the origin remote.
190
f496454e 191--depth <depth>::
f4bf2184 192 Create a 'shallow' clone with a history truncated to the
d22eb044
SB
193 specified number of revisions. Implies `--single-branch` unless
194 `--no-single-branch` is given to fetch the histories near the
18a74a09
JH
195 tips of all branches. If you want to clone submodules shallowly,
196 also pass `--shallow-submodules`.
f4bf2184 197
0460ed2c 198--[no-]single-branch::
3e6e0edd
NTND
199 Clone only the history leading to the tip of a single branch,
200 either specified by the `--branch` option or the primary
201 branch remote's `HEAD` points at. When creating a shallow
202 clone with the `--depth` option, this is the default, unless
203 `--no-single-branch` is given to fetch the histories near the
204 tips of all branches.
31b808a0 205 Further fetches into the resulting repository will only update the
a6d3bde5 206 remote-tracking branch for the branch this option was used for the
31b808a0 207 initial cloning. If the HEAD at the remote did not point at any
a6d3bde5 208 branch when `--single-branch` clone was made, no remote-tracking
31b808a0 209 branch is created.
3e6e0edd 210
e7fed18a 211--recursive::
ccdd3da6 212--recurse-submodules::
e7fed18a
JH
213 After the clone is created, initialize all submodules within,
214 using their default settings. This is equivalent to running
550c66f3 215 `git submodule update --init --recursive` immediately after
e7fed18a
JH
216 the clone is finished. This option is ignored if the cloned
217 repository does not have a worktree/checkout (i.e. if any of
218 `--no-checkout`/`-n`, `--bare`, or `--mirror` is given)
219
d22eb044
SB
220--[no-]shallow-submodules::
221 All submodules which are cloned will be shallow with a depth of 1.
222
b57fb80a
NTND
223--separate-git-dir=<git dir>::
224 Instead of placing the cloned repository where it is supposed
225 to be, place the cloned repository at the specified directory,
5fe8f49b 226 then make a filesystem-agnostic Git symbolic link to there.
2de9b711 227 The result is Git repository can be separated from working
b57fb80a
NTND
228 tree.
229
72290d6a
SB
230-j <n>::
231--jobs <n>::
232 The number of submodules fetched at the same time.
233 Defaults to the `submodule.fetchJobs` option.
b57fb80a 234
6ec311da 235<repository>::
37ba0561
AR
236 The (possibly remote) repository to clone from. See the
237 <<URLS,URLS>> section below for more information on specifying
238 repositories.
6ec311da
JH
239
240<directory>::
fb6a9f93 241 The name of a new directory to clone into. The "humanish"
0879aa28 242 part of the source repository is used if no directory is
550c66f3
BG
243 explicitly given (`repo` for `/path/to/repo.git` and `foo`
244 for `host.xz:foo/.git`). Cloning into an existing directory
ec00d6e0 245 is only allowed if the directory is empty.
4607166d 246
347989f4 247:git-clone: 1
37ba0561
AR
248include::urls.txt[]
249
1e2ccd3a 250Examples
2b5f3ed3 251--------
1e2ccd3a 252
47638685 253* Clone from upstream:
1e2ccd3a
JH
254+
255------------
283efb01
TK
256$ git clone git://git.kernel.org/pub/scm/.../linux.git my-linux
257$ cd my-linux
1e2ccd3a
JH
258$ make
259------------
260
261
47638685 262* Make a local clone that borrows from the current directory, without checking things out:
1e2ccd3a
JH
263+
264------------
265$ git clone -l -s -n . ../copy
a6e3768f 266$ cd ../copy
1e2ccd3a
JH
267$ git show-branch
268------------
269
8a1a120c 270
47638685 271* Clone from upstream while borrowing from an existing local directory:
23edecbc
SP
272+
273------------
f22a6543
TK
274$ git clone --reference /git/linux.git \
275 git://git.kernel.org/pub/scm/.../linux.git \
276 my-linux
277$ cd my-linux
23edecbc
SP
278------------
279
280
47638685 281* Create a bare repository to publish your changes to the public:
8a1a120c
JH
282+
283------------
87e80c4b 284$ git clone --bare -l /home/proj/.git /pub/scm/proj.git
8a1a120c
JH
285------------
286
287
6ec311da
JH
288GIT
289---
9e1f0a85 290Part of the linkgit:git[1] suite