2005-09-08 00:26:23 +00:00
|
|
|
git-clone(1)
|
|
|
|
|
============
|
2005-07-14 03:25:54 +00:00
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
2007-06-09 15:44:12 +00:00
|
|
|
git-clone - Clone a repository into a new directory
|
2005-07-14 03:25:54 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
2005-12-31 17:37:15 +00:00
|
|
|
[verse]
|
2021-11-06 18:48:52 +00:00
|
|
|
'git clone' [--template=<template-directory>]
|
2008-08-02 19:38:56 +00:00
|
|
|
[-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [--mirror]
|
2009-11-30 13:27:52 +00:00
|
|
|
[-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>]
|
2021-11-06 18:48:52 +00:00
|
|
|
[--dissociate] [--separate-git-dir <git-dir>]
|
2017-04-26 23:12:33 +00:00
|
|
|
[--depth <depth>] [--[no-]single-branch] [--no-tags]
|
2017-12-05 02:53:32 +00:00
|
|
|
[--recurse-submodules[=<pathspec>]] [--[no-]shallow-submodules]
|
2021-04-01 10:46:59 +00:00
|
|
|
[--[no-]remote-submodules] [--jobs <n>] [--sparse] [--[no-]reject-shallow]
|
clone, submodule: pass partial clone filters to submodules
When cloning a repo with a --filter and with --recurse-submodules
enabled, the partial clone filter only applies to the top-level repo.
This can lead to unexpected bandwidth and disk usage for projects which
include large submodules. For example, a user might wish to make a
partial clone of Gerrit and would run:
`git clone --recurse-submodules --filter=blob:5k https://gerrit.googlesource.com/gerrit`.
However, only the superproject would be a partial clone; all the
submodules would have all blobs downloaded regardless of their size.
With this change, the same filter can also be applied to submodules,
meaning the expected bandwidth and disk savings apply consistently.
To avoid changing default behavior, add a new clone flag,
`--also-filter-submodules`. When this is set along with `--filter` and
`--recurse-submodules`, the filter spec is passed along to git-submodule
and git-submodule--helper, such that submodule clones also have the
filter applied.
This applies the same filter to the superproject and all submodules.
Users who need to customize the filter per-submodule would need to clone
with `--no-recurse-submodules` and then manually initialize each
submodule with the proper filter.
Applying filters to submodules should be safe thanks to Jonathan Tan's
recent work [1, 2, 3] eliminating the use of alternates as a method of
accessing submodule objects, so any submodule object access now triggers
a lazy fetch from the submodule's promisor remote if the accessed object
is missing. This patch is a reworked version of [4], which was created
prior to Jonathan Tan's work.
[1]: 8721e2e (Merge branch 'jt/partial-clone-submodule-1', 2021-07-16)
[2]: 11e5d0a (Merge branch 'jt/grep-wo-submodule-odb-as-alternate',
2021-09-20)
[3]: 162a13b (Merge branch 'jt/no-abuse-alternate-odb-for-submodules',
2021-10-25)
[4]: https://lore.kernel.org/git/52bf9d45b8e2b72ff32aa773f2415bf7b2b86da2.1563322192.git.steadmon@google.com/
Signed-off-by: Josh Steadmon <steadmon@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2022-02-05 05:00:49 +00:00
|
|
|
[--filter=<filter> [--also-filter-submodules]] [--] <repository>
|
2019-05-19 14:26:49 +00:00
|
|
|
[<directory>]
|
2005-07-14 03:25:54 +00:00
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
2005-11-06 06:26:52 +00:00
|
|
|
|
2006-12-08 06:27:21 +00:00
|
|
|
Clones a repository into a newly created directory, creates
|
|
|
|
|
remote-tracking branches for each branch in the cloned repository
|
2019-07-02 14:37:40 +00:00
|
|
|
(visible using `git branch --remotes`), and creates and checks out an
|
2009-10-09 23:07:39 +00:00
|
|
|
initial branch that is forked from the cloned repository's
|
|
|
|
|
currently active branch.
|
2005-11-06 06:26:52 +00:00
|
|
|
|
2006-12-08 06:27:21 +00: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
|
2012-09-20 18:04:08 +00:00
|
|
|
current master branch, if any (this is untrue when "--single-branch"
|
|
|
|
|
is given; see below).
|
2005-11-06 06:26:52 +00:00
|
|
|
|
2006-12-08 06:27:21 +00:00
|
|
|
This default configuration is achieved by creating references to
|
docs: don't talk about $GIT_DIR/refs/ everywhere
It is misleading to say that we pull refs from $GIT_DIR/refs/*, because we
may also consult the packed refs mechanism. These days we tend to treat
the "refs hierarchy" as more of an abstract namespace that happens to be
represented as $GIT_DIR/refs. At best, this is a minor inaccuracy, but at
worst it can confuse users who then look in $GIT_DIR/refs and find that it
is missing some of the refs they expected to see.
This patch drops most uses of "$GIT_DIR/refs/*", changing them into just
"refs/*", under the assumption that users can handle the concept of an
abstract refs namespace. There are a few things to note:
- most cases just dropped the $GIT_DIR/ portion. But for cases where
that left _just_ the word "refs", I changed it to "refs/" to help
indicate that it was a hierarchy. I didn't do the same for longer
paths (e.g., "refs/heads" remained, instead of becoming
"refs/heads/").
- in some cases, no change was made, as the text was explicitly about
unpacked refs (e.g., the discussion in git-pack-refs).
- In some cases it made sense instead to note the existence of packed
refs (e.g., in check-ref-format and rev-parse).
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-02-18 01:16:20 +00:00
|
|
|
the remote branch heads under `refs/remotes/origin` and
|
2006-12-08 06:27:21 +00:00
|
|
|
by initializing `remote.origin.url` and `remote.origin.fetch`
|
|
|
|
|
configuration variables.
|
2005-07-14 03:25:54 +00:00
|
|
|
|
2007-01-01 23:08:06 +00:00
|
|
|
|
2005-07-14 03:25:54 +00:00
|
|
|
OPTIONS
|
|
|
|
|
-------
|
|
|
|
|
-l::
|
2019-07-02 14:37:41 +00:00
|
|
|
--local::
|
2005-07-14 03:25:54 +00:00
|
|
|
When the repository to clone from is on a local machine,
|
2013-01-21 19:17:53 +00:00
|
|
|
this flag bypasses the normal "Git aware" transport
|
2005-07-14 03:25:54 +00:00
|
|
|
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 06:42:36 +00:00
|
|
|
The files under `.git/objects/` directory are hardlinked
|
2012-05-30 11:09:08 +00:00
|
|
|
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
|
2012-05-30 11:10:16 +00:00
|
|
|
never use the local optimizations). Specifying `--no-local` will
|
|
|
|
|
override the default when `/path/to/repo` is given, using the regular
|
2013-01-21 19:17:53 +00:00
|
|
|
Git transport instead.
|
2021-01-11 19:25:10 +00:00
|
|
|
+
|
clone: error specifically with --local and symlinked objects
6f054f9fb3 (builtin/clone.c: disallow --local clones with
symlinks, 2022-07-28) gives a good error message when "git clone
--local" fails when the repo to clone has symlinks in
"$GIT_DIR/objects". In bffc762f87 (dir-iterator: prevent top-level
symlinks without FOLLOW_SYMLINKS, 2023-01-24), we later extended this
restriction to the case where "$GIT_DIR/objects" is itself a symlink,
but we didn't update the error message then - bffc762f87's tests show
that we print a generic "failed to start iterator over" message.
This is exacerbated by the fact that Documentation/git-clone.txt
mentions neither restriction, so users are left wondering if this is
intentional behavior or not.
Fix this by adding a check to builtin/clone.c: when doing a local clone,
perform an extra check to see if "$GIT_DIR/objects" is a symlink, and if
so, assume that that was the reason for the failure and report the
relevant information. Ideally, dir_iterator_begin() would tell us that
the real failure reason is the presence of the symlink, but (as far as I
can tell) there isn't an appropriate errno value for that.
Also, update Documentation/git-clone.txt to reflect that this
restriction exists.
Signed-off-by: Glen Choo <chooglen@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2023-04-10 22:18:50 +00:00
|
|
|
If the repository's `$GIT_DIR/objects` has symbolic links or is a
|
|
|
|
|
symbolic link, the clone will fail. This is a security measure to
|
|
|
|
|
prevent the unintentional copying of files by dereferencing the symbolic
|
|
|
|
|
links.
|
|
|
|
|
+
|
2021-01-11 19:25:10 +00:00
|
|
|
*NOTE*: this operation can race with concurrent modification to the
|
|
|
|
|
source repository, similar to running `cp -r src dst` while modifying
|
|
|
|
|
`src`.
|
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 06:42:36 +00:00
|
|
|
|
|
|
|
|
--no-hardlinks::
|
2014-02-08 20:41:36 +00:00
|
|
|
Force the cloning process from a repository on a local
|
|
|
|
|
filesystem to copy the files under the `.git/objects`
|
|
|
|
|
directory instead of using hardlinks. This may be desirable
|
|
|
|
|
if you are trying to make a back-up of your repository.
|
2005-07-14 03:25:54 +00:00
|
|
|
|
2005-10-02 19:42:57 +00:00
|
|
|
-s::
|
2019-07-02 14:37:41 +00:00
|
|
|
--shared::
|
2005-10-02 19:42:57 +00:00
|
|
|
When the repository to clone is on the local machine,
|
2005-11-06 06:26:52 +00:00
|
|
|
instead of using hard links, automatically setup
|
2009-10-20 20:38:38 +00:00
|
|
|
`.git/objects/info/alternates` to share the objects
|
2005-11-06 06:26:52 +00:00
|
|
|
with the source repository. The resulting repository
|
|
|
|
|
starts out without any object of its own.
|
2008-02-12 00:12:57 +00: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 18:26:13 +00:00
|
|
|
repository using this option and then delete branches (or use any
|
2013-01-21 19:17:53 +00:00
|
|
|
other Git command that makes any existing commit unreferenced) in the
|
2008-04-03 18:26:13 +00:00
|
|
|
source repository, some objects may become unreferenced (or dangling).
|
2013-01-21 19:17:53 +00:00
|
|
|
These objects may be removed by normal Git operations (such as `git commit`)
|
2020-09-17 18:11:44 +00:00
|
|
|
which automatically call `git maintenance run --auto`. (See
|
|
|
|
|
linkgit:git-maintenance[1].) If these objects are removed and were referenced
|
|
|
|
|
by the cloned repository, then the cloned repository will become corrupt.
|
2009-08-17 06:19:17 +00:00
|
|
|
+
|
2019-07-02 14:37:40 +00:00
|
|
|
Note that running `git repack` without the `--local` option in a repository
|
|
|
|
|
cloned with `--shared` will copy objects from the source repository into a pack
|
|
|
|
|
in the cloned repository, removing the disk space savings of `clone --shared`.
|
|
|
|
|
It is safe, however, to run `git gc`, which uses the `--local` option by
|
2009-08-17 06:19:17 +00:00
|
|
|
default.
|
|
|
|
|
+
|
2019-07-02 14:37:40 +00:00
|
|
|
If you want to break the dependency of a repository cloned with `--shared` on
|
2009-08-17 06:19:17 +00:00
|
|
|
its source repository, you can simply run `git repack -a` to copy all
|
|
|
|
|
objects from the source repository into a pack in the cloned repository.
|
2005-10-02 19:42:57 +00:00
|
|
|
|
2016-08-15 21:53:26 +00:00
|
|
|
--reference[-if-able] <repository>::
|
2009-09-03 11:24:16 +00:00
|
|
|
If the reference repository is on the local machine,
|
2009-10-20 20:38:38 +00:00
|
|
|
automatically setup `.git/objects/info/alternates` to
|
2006-04-19 00:19:48 +00:00
|
|
|
obtain objects from the reference repository. Using
|
|
|
|
|
an already existing repository as an alternate will
|
2007-09-07 16:43:37 +00:00
|
|
|
require fewer objects to be copied from the repository
|
2006-04-19 00:19:48 +00:00
|
|
|
being cloned, reducing network and local storage costs.
|
2016-08-15 21:53:26 +00:00
|
|
|
When using the `--reference-if-able`, a non existing
|
|
|
|
|
directory is skipped with a warning instead of aborting
|
|
|
|
|
the clone.
|
2008-04-03 18:26:13 +00:00
|
|
|
+
|
2014-10-14 19:38:52 +00:00
|
|
|
*NOTE*: see the NOTE for the `--shared` option, and also the
|
|
|
|
|
`--dissociate` option.
|
|
|
|
|
|
|
|
|
|
--dissociate::
|
|
|
|
|
Borrow the objects from reference repositories specified
|
|
|
|
|
with the `--reference` options only to reduce network
|
2015-10-22 16:41:17 +00:00
|
|
|
transfer, and stop borrowing from them after a clone is made
|
|
|
|
|
by making necessary local copies of borrowed objects. This
|
|
|
|
|
option can also be used when cloning locally from a
|
|
|
|
|
repository that already borrows objects from another
|
|
|
|
|
repository--the new repository will borrow objects from the
|
|
|
|
|
same repository, and this option can be used to stop the
|
|
|
|
|
borrowing.
|
2006-04-19 00:19:48 +00:00
|
|
|
|
2005-07-14 03:25:54 +00:00
|
|
|
-q::
|
2019-07-02 14:37:41 +00:00
|
|
|
--quiet::
|
2009-12-25 17:12:04 +00:00
|
|
|
Operate quietly. Progress is not reported to the standard
|
transport: drop support for git-over-rsync
The git-over-rsync protocol is inefficient and broken, and
has been for a long time. It transfers way more objects than
it needs (grabbing all of the remote's "objects/",
regardless of which objects we need). It does its own ad-hoc
parsing of loose and packed refs from the remote, but
doesn't properly override packed refs with loose ones,
leading to garbage results (e.g., expecting the other side
to have an object pointed to by a stale packed-refs entry,
or complaining that the other side has two copies of the
refs[1]).
This latter breakage means that nobody could have
successfully pulled from a moderately active repository
since cd547b4 (fetch/push: readd rsync support, 2007-10-01).
We never made an official deprecation notice in the release
notes for git's rsync protocol, but the tutorial has marked
it as such since 914328a (Update tutorial., 2005-08-30).
And on the mailing list as far back as Oct 2005, we can find
Junio mentioning it as having "been deprecated for quite
some time."[2,3,4]. So it was old news then; cogito had
deprecated the transport in July of 2005[5] (though it did
come back briefly when Linus broke git-http-pull!).
Of course some people professed their love of rsync through
2006, but Linus clarified in his usual gentle manner[6]:
> Thanks! This is why I still use rsync, even though
> everybody and their mother tells me "Linus says rsync is
> deprecated."
No. You're using rsync because you're actively doing
something _wrong_.
The deprecation sentiment was reinforced in 2008, with a
mention that cloning via rsync is broken (with no fix)[7].
Even the commit porting rsync over to C from shell (cd547b4)
lists it as deprecated! So between the 10 years of informal
warnings, and the fact that it has been severely broken
since 2007, it's probably safe to simply remove it without
further deprecation warnings.
[1] http://article.gmane.org/gmane.comp.version-control.git/285101
[2] http://article.gmane.org/gmane.comp.version-control.git/10093
[3] http://article.gmane.org/gmane.comp.version-control.git/17734
[4] http://article.gmane.org/gmane.comp.version-control.git/18911
[5] http://article.gmane.org/gmane.comp.version-control.git/5617
[6] http://article.gmane.org/gmane.comp.version-control.git/19354
[7] http://article.gmane.org/gmane.comp.version-control.git/103635
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2016-01-30 07:21:26 +00:00
|
|
|
error stream.
|
2005-07-14 03:25:54 +00:00
|
|
|
|
2008-10-08 23:40:32 +00:00
|
|
|
-v::
|
2019-07-02 14:37:41 +00:00
|
|
|
--verbose::
|
2010-02-24 12:50:20 +00:00
|
|
|
Run verbosely. Does not affect the reporting of progress status
|
|
|
|
|
to the standard error stream.
|
2009-12-25 17:12:06 +00:00
|
|
|
|
|
|
|
|
--progress::
|
2009-12-25 17:12:04 +00:00
|
|
|
Progress status is reported on the standard error stream
|
2019-07-02 14:37:40 +00:00
|
|
|
by default when it is attached to a terminal, unless `--quiet`
|
2009-12-25 17:12:04 +00:00
|
|
|
is specified. This flag forces progress status even if the
|
|
|
|
|
standard error stream is not directed to a terminal.
|
2008-10-08 23:40:32 +00:00
|
|
|
|
2019-04-12 19:51:22 +00:00
|
|
|
--server-option=<option>::
|
|
|
|
|
Transmit the given string to the server when communicating using
|
|
|
|
|
protocol version 2. The given string must not contain a NUL or LF
|
|
|
|
|
character. The server's handling of server options, including
|
|
|
|
|
unknown ones, is server-specific.
|
|
|
|
|
When multiple `--server-option=<option>` are given, they are all
|
|
|
|
|
sent to the other side in the order listed on the command line.
|
|
|
|
|
|
2005-10-02 19:42:57 +00:00
|
|
|
-n::
|
2019-07-02 14:37:41 +00:00
|
|
|
--no-checkout::
|
2005-10-02 19:42:57 +00:00
|
|
|
No checkout of HEAD is performed after the clone is complete.
|
|
|
|
|
|
2021-04-01 10:46:59 +00:00
|
|
|
--[no-]reject-shallow::
|
|
|
|
|
Fail if the source repository is a shallow repository.
|
|
|
|
|
The 'clone.rejectShallow' configuration variable can be used to
|
|
|
|
|
specify the default.
|
|
|
|
|
|
2006-01-23 01:24:22 +00:00
|
|
|
--bare::
|
2013-01-21 19:16:20 +00:00
|
|
|
Make a 'bare' Git repository. That is, instead of
|
2006-01-15 00:00:32 +00:00
|
|
|
creating `<directory>` and placing the administrative
|
|
|
|
|
files in `<directory>/.git`, make the `<directory>`
|
2019-07-02 14:37:40 +00:00
|
|
|
itself the `$GIT_DIR`. This obviously implies the `--no-checkout`
|
2006-11-23 22:58:35 +00:00
|
|
|
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
|
2006-12-31 23:47:34 +00:00
|
|
|
used, neither remote-tracking branches nor the related
|
|
|
|
|
configuration variables are created.
|
2006-01-15 00:00:32 +00:00
|
|
|
|
2019-11-21 22:04:35 +00:00
|
|
|
--sparse::
|
2021-12-14 04:09:11 +00:00
|
|
|
Employ a sparse-checkout, with only files in the toplevel
|
|
|
|
|
directory initially being present. The
|
|
|
|
|
linkgit:git-sparse-checkout[1] command can be used to grow the
|
|
|
|
|
working directory as needed.
|
2019-11-21 22:04:35 +00:00
|
|
|
|
2020-03-22 19:50:06 +00:00
|
|
|
--filter=<filter-spec>::
|
|
|
|
|
Use the partial clone feature and request that the server sends
|
|
|
|
|
a subset of reachable objects according to a given object filter.
|
|
|
|
|
When using `--filter`, the supplied `<filter-spec>` is used for
|
|
|
|
|
the partial clone filter. For example, `--filter=blob:none` will
|
|
|
|
|
filter out all blobs (file contents) until needed by Git. Also,
|
|
|
|
|
`--filter=blob:limit=<size>` will filter out all blobs of size
|
|
|
|
|
at least `<size>`. For more details on filter specifications, see
|
|
|
|
|
the `--filter` option in linkgit:git-rev-list[1].
|
|
|
|
|
|
clone, submodule: pass partial clone filters to submodules
When cloning a repo with a --filter and with --recurse-submodules
enabled, the partial clone filter only applies to the top-level repo.
This can lead to unexpected bandwidth and disk usage for projects which
include large submodules. For example, a user might wish to make a
partial clone of Gerrit and would run:
`git clone --recurse-submodules --filter=blob:5k https://gerrit.googlesource.com/gerrit`.
However, only the superproject would be a partial clone; all the
submodules would have all blobs downloaded regardless of their size.
With this change, the same filter can also be applied to submodules,
meaning the expected bandwidth and disk savings apply consistently.
To avoid changing default behavior, add a new clone flag,
`--also-filter-submodules`. When this is set along with `--filter` and
`--recurse-submodules`, the filter spec is passed along to git-submodule
and git-submodule--helper, such that submodule clones also have the
filter applied.
This applies the same filter to the superproject and all submodules.
Users who need to customize the filter per-submodule would need to clone
with `--no-recurse-submodules` and then manually initialize each
submodule with the proper filter.
Applying filters to submodules should be safe thanks to Jonathan Tan's
recent work [1, 2, 3] eliminating the use of alternates as a method of
accessing submodule objects, so any submodule object access now triggers
a lazy fetch from the submodule's promisor remote if the accessed object
is missing. This patch is a reworked version of [4], which was created
prior to Jonathan Tan's work.
[1]: 8721e2e (Merge branch 'jt/partial-clone-submodule-1', 2021-07-16)
[2]: 11e5d0a (Merge branch 'jt/grep-wo-submodule-odb-as-alternate',
2021-09-20)
[3]: 162a13b (Merge branch 'jt/no-abuse-alternate-odb-for-submodules',
2021-10-25)
[4]: https://lore.kernel.org/git/52bf9d45b8e2b72ff32aa773f2415bf7b2b86da2.1563322192.git.steadmon@google.com/
Signed-off-by: Josh Steadmon <steadmon@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2022-02-05 05:00:49 +00:00
|
|
|
--also-filter-submodules::
|
|
|
|
|
Also apply the partial clone filter to any submodules in the repository.
|
|
|
|
|
Requires `--filter` and `--recurse-submodules`. This can be turned on by
|
|
|
|
|
default by setting the `clone.filterSubmodules` config option.
|
|
|
|
|
|
2008-08-02 19:38:56 +00:00
|
|
|
--mirror::
|
2010-10-04 17:28:27 +00:00
|
|
|
Set up a mirror of the source repository. This implies `--bare`.
|
|
|
|
|
Compared to `--bare`, `--mirror` not only maps local branches of the
|
|
|
|
|
source to local branches of the target, it maps all refs (including
|
2010-11-02 15:31:24 +00:00
|
|
|
remote-tracking branches, notes etc.) and sets up a refspec configuration such
|
2010-10-04 17:28:27 +00:00
|
|
|
that all these refs are overwritten by a `git remote update` in the
|
|
|
|
|
target repository.
|
2008-08-02 19:38:56 +00:00
|
|
|
|
2005-12-22 22:37:24 +00:00
|
|
|
-o <name>::
|
2019-07-02 14:37:41 +00:00
|
|
|
--origin <name>::
|
2020-10-01 03:46:16 +00:00
|
|
|
Instead of using the remote name `origin` to keep track of the upstream
|
|
|
|
|
repository, use `<name>`. Overrides `clone.defaultRemoteName` from the
|
|
|
|
|
config.
|
2005-12-22 22:37:24 +00:00
|
|
|
|
2009-08-26 19:05:08 +00:00
|
|
|
-b <name>::
|
2019-07-02 14:37:41 +00:00
|
|
|
--branch <name>::
|
2009-08-26 19:05:08 +00:00
|
|
|
Instead of pointing the newly created HEAD to the branch pointed
|
2009-10-20 20:38:38 +00:00
|
|
|
to by the cloned repository's HEAD, point to `<name>` branch
|
2012-09-20 18:04:08 +00:00
|
|
|
instead. In a non-bare repository, this is the branch that will
|
|
|
|
|
be checked out.
|
|
|
|
|
`--branch` can also take tags and detaches the HEAD at that commit
|
|
|
|
|
in the resulting repository.
|
2009-08-26 19:05:08 +00:00
|
|
|
|
2005-07-14 03:25:54 +00:00
|
|
|
-u <upload-pack>::
|
2019-07-02 14:37:41 +00:00
|
|
|
--upload-pack <upload-pack>::
|
2008-07-25 18:37:48 +00:00
|
|
|
When given, and the repository to clone from is accessed
|
|
|
|
|
via ssh, this specifies a non-default path for the command
|
2005-07-14 03:25:54 +00:00
|
|
|
run on the other end.
|
|
|
|
|
|
2021-11-06 18:48:52 +00:00
|
|
|
--template=<template-directory>::
|
2006-05-28 17:14:38 +00:00
|
|
|
Specify the directory from which templates will be used;
|
2010-02-16 23:44:46 +00:00
|
|
|
(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
|
2006-05-28 17:14:38 +00:00
|
|
|
|
2011-06-09 20:56:19 +00:00
|
|
|
-c <key>=<value>::
|
2019-07-02 14:37:41 +00:00
|
|
|
--config <key>=<value>::
|
2011-06-09 20:56:19 +00:00
|
|
|
Set a configuration variable in the newly-created repository;
|
|
|
|
|
this takes effect immediately after the repository is
|
|
|
|
|
initialized, but before the remote history is fetched or any
|
|
|
|
|
files checked out. The key is in the same format as expected by
|
|
|
|
|
linkgit:git-config[1] (e.g., `core.eol=true`). If multiple
|
|
|
|
|
values are given for the same key, each value will be written to
|
|
|
|
|
the config file. This makes it safe, for example, to add
|
|
|
|
|
additional fetch refspecs to the origin remote.
|
2018-11-14 10:46:20 +00:00
|
|
|
+
|
|
|
|
|
Due to limitations of the current implementation, some configuration
|
|
|
|
|
variables do not take effect until after the initial fetch and checkout.
|
|
|
|
|
Configuration variables known to not take effect are:
|
|
|
|
|
`remote.<name>.mirror` and `remote.<name>.tagOpt`. Use the
|
|
|
|
|
corresponding `--mirror` and `--no-tags` options instead.
|
2011-06-09 20:56:19 +00:00
|
|
|
|
2007-02-19 12:35:35 +00:00
|
|
|
--depth <depth>::
|
2007-01-01 23:08:06 +00:00
|
|
|
Create a 'shallow' clone with a history truncated to the
|
2016-01-08 09:18:21 +00:00
|
|
|
specified number of commits. Implies `--single-branch` unless
|
2016-01-06 13:06:47 +00:00
|
|
|
`--no-single-branch` is given to fetch the histories near the
|
2016-06-19 20:51:56 +00:00
|
|
|
tips of all branches. If you want to clone submodules shallowly,
|
|
|
|
|
also pass `--shallow-submodules`.
|
2007-01-01 23:08:06 +00:00
|
|
|
|
2016-06-12 10:54:00 +00:00
|
|
|
--shallow-since=<date>::
|
|
|
|
|
Create a shallow clone with a history after the specified time.
|
|
|
|
|
|
2016-06-12 10:54:05 +00:00
|
|
|
--shallow-exclude=<revision>::
|
|
|
|
|
Create a shallow clone with a history, excluding commits
|
|
|
|
|
reachable from a specified remote branch or tag. This option
|
|
|
|
|
can be specified multiple times.
|
|
|
|
|
|
2013-05-09 01:16:55 +00:00
|
|
|
--[no-]single-branch::
|
2012-01-07 14:45:59 +00:00
|
|
|
Clone only the history leading to the tip of a single branch,
|
|
|
|
|
either specified by the `--branch` option or the primary
|
2016-01-06 13:06:47 +00:00
|
|
|
branch remote's `HEAD` points at.
|
2012-09-20 18:04:08 +00:00
|
|
|
Further fetches into the resulting repository will only update the
|
2012-10-23 11:34:05 +00:00
|
|
|
remote-tracking branch for the branch this option was used for the
|
2012-09-20 18:04:08 +00:00
|
|
|
initial cloning. If the HEAD at the remote did not point at any
|
2012-10-23 11:34:05 +00:00
|
|
|
branch when `--single-branch` clone was made, no remote-tracking
|
2012-09-20 18:04:08 +00:00
|
|
|
branch is created.
|
2012-01-07 14:45:59 +00:00
|
|
|
|
2017-04-26 23:12:33 +00:00
|
|
|
--no-tags::
|
|
|
|
|
Don't clone any tags, and set
|
|
|
|
|
`remote.<remote>.tagOpt=--no-tags` in the config, ensuring
|
|
|
|
|
that future `git pull` and `git fetch` operations won't follow
|
|
|
|
|
any tags. Subsequent explicit tag fetches will still work,
|
|
|
|
|
(see linkgit:git-fetch[1]).
|
|
|
|
|
+
|
|
|
|
|
Can be used in conjunction with `--single-branch` to clone and
|
|
|
|
|
maintain a branch with no references other than a single cloned
|
|
|
|
|
branch. This is useful e.g. to maintain minimal clones of the default
|
|
|
|
|
branch of some repository for search indexing.
|
|
|
|
|
|
2020-06-24 14:46:31 +00:00
|
|
|
--recurse-submodules[=<pathspec>]::
|
2017-03-17 22:38:03 +00:00
|
|
|
After the clone is created, initialize and clone submodules
|
|
|
|
|
within based on the provided pathspec. If no pathspec is
|
|
|
|
|
provided, all submodules are initialized and cloned.
|
2017-12-05 02:53:32 +00:00
|
|
|
This option can be given multiple times for pathspecs consisting
|
|
|
|
|
of multiple entries. The resulting clone has `submodule.active` set to
|
2017-03-17 22:38:03 +00:00
|
|
|
the provided pathspec, or "." (meaning all submodules) if no
|
2017-12-05 02:53:32 +00:00
|
|
|
pathspec is provided.
|
|
|
|
|
+
|
|
|
|
|
Submodules are initialized and cloned using their default settings. This is
|
|
|
|
|
equivalent to running
|
|
|
|
|
`git submodule update --init --recursive <pathspec>` immediately after
|
|
|
|
|
the clone is finished. This option is ignored if the cloned repository does
|
|
|
|
|
not have a worktree/checkout (i.e. if any of `--no-checkout`/`-n`, `--bare`,
|
|
|
|
|
or `--mirror` is given)
|
2009-08-19 23:07:43 +00:00
|
|
|
|
2016-04-26 01:12:27 +00:00
|
|
|
--[no-]shallow-submodules::
|
|
|
|
|
All submodules which are cloned will be shallow with a depth of 1.
|
|
|
|
|
|
2019-05-19 14:26:49 +00:00
|
|
|
--[no-]remote-submodules::
|
2019-12-12 20:46:54 +00:00
|
|
|
All submodules which are cloned will use the status of the submodule's
|
2019-05-19 14:26:49 +00:00
|
|
|
remote-tracking branch to update the submodule, rather than the
|
2019-12-12 20:46:54 +00:00
|
|
|
superproject's recorded SHA-1. Equivalent to passing `--remote` to
|
2019-05-19 14:26:49 +00:00
|
|
|
`git submodule update`.
|
|
|
|
|
|
2021-11-06 18:48:52 +00:00
|
|
|
--separate-git-dir=<git-dir>::
|
2011-03-19 15:16:56 +00:00
|
|
|
Instead of placing the cloned repository where it is supposed
|
|
|
|
|
to be, place the cloned repository at the specified directory,
|
2014-02-05 22:19:43 +00:00
|
|
|
then make a filesystem-agnostic Git symbolic link to there.
|
2013-01-21 19:17:53 +00:00
|
|
|
The result is Git repository can be separated from working
|
2011-03-19 15:16:56 +00:00
|
|
|
tree.
|
|
|
|
|
|
2016-03-01 02:07:20 +00:00
|
|
|
-j <n>::
|
|
|
|
|
--jobs <n>::
|
|
|
|
|
The number of submodules fetched at the same time.
|
|
|
|
|
Defaults to the `submodule.fetchJobs` option.
|
2011-03-19 15:16:56 +00:00
|
|
|
|
2005-07-14 03:25:54 +00:00
|
|
|
<repository>::
|
2007-07-04 22:21:36 +00:00
|
|
|
The (possibly remote) repository to clone from. See the
|
2018-04-19 17:32:30 +00:00
|
|
|
<<URLS,GIT URLS>> section below for more information on specifying
|
2007-07-04 22:21:36 +00:00
|
|
|
repositories.
|
2005-07-14 03:25:54 +00:00
|
|
|
|
|
|
|
|
<directory>::
|
2006-06-08 06:50:09 +00:00
|
|
|
The name of a new directory to clone into. The "humanish"
|
2005-11-10 11:58:08 +00:00
|
|
|
part of the source repository is used if no directory is
|
2009-10-20 20:38:38 +00:00
|
|
|
explicitly given (`repo` for `/path/to/repo.git` and `foo`
|
|
|
|
|
for `host.xz:foo/.git`). Cloning into an existing directory
|
2009-05-07 12:04:08 +00:00
|
|
|
is only allowed if the directory is empty.
|
2005-11-06 06:26:52 +00:00
|
|
|
|
2022-08-09 13:11:41 +00:00
|
|
|
--bundle-uri=<uri>::
|
|
|
|
|
Before fetching from the remote, fetch a bundle from the given
|
|
|
|
|
`<uri>` and unbundle the data into the local repository. The refs
|
|
|
|
|
in the bundle will be stored under the hidden `refs/bundle/*`
|
2022-08-09 13:11:43 +00:00
|
|
|
namespace. This option is incompatible with `--depth`,
|
|
|
|
|
`--shallow-since`, and `--shallow-exclude`.
|
2022-08-09 13:11:41 +00:00
|
|
|
|
2007-11-16 18:43:16 +00:00
|
|
|
:git-clone: 1
|
2007-07-04 22:21:36 +00:00
|
|
|
include::urls.txt[]
|
|
|
|
|
|
2018-04-30 15:35:33 +00:00
|
|
|
EXAMPLES
|
2006-05-05 19:05:10 +00:00
|
|
|
--------
|
2005-12-13 07:24:06 +00:00
|
|
|
|
2010-03-21 17:30:19 +00:00
|
|
|
* Clone from upstream:
|
2005-12-13 07:24:06 +00:00
|
|
|
+
|
|
|
|
|
------------
|
2013-06-22 14:46:27 +00:00
|
|
|
$ git clone git://git.kernel.org/pub/scm/.../linux.git my-linux
|
|
|
|
|
$ cd my-linux
|
2005-12-13 07:24:06 +00:00
|
|
|
$ make
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
|
2010-03-21 17:30:19 +00:00
|
|
|
* Make a local clone that borrows from the current directory, without checking things out:
|
2005-12-13 07:24:06 +00:00
|
|
|
+
|
|
|
|
|
------------
|
|
|
|
|
$ git clone -l -s -n . ../copy
|
2007-05-12 11:32:34 +00:00
|
|
|
$ cd ../copy
|
2005-12-13 07:24:06 +00:00
|
|
|
$ git show-branch
|
|
|
|
|
------------
|
|
|
|
|
|
2006-01-15 00:00:32 +00:00
|
|
|
|
2010-03-21 17:30:19 +00:00
|
|
|
* Clone from upstream while borrowing from an existing local directory:
|
2006-04-19 00:19:48 +00:00
|
|
|
+
|
|
|
|
|
------------
|
2013-06-22 14:46:25 +00:00
|
|
|
$ git clone --reference /git/linux.git \
|
|
|
|
|
git://git.kernel.org/pub/scm/.../linux.git \
|
|
|
|
|
my-linux
|
|
|
|
|
$ cd my-linux
|
2006-04-19 00:19:48 +00:00
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
|
2010-03-21 17:30:19 +00:00
|
|
|
* Create a bare repository to publish your changes to the public:
|
2006-01-15 00:00:32 +00:00
|
|
|
+
|
|
|
|
|
------------
|
2006-01-23 01:24:22 +00:00
|
|
|
$ git clone --bare -l /home/proj/.git /pub/scm/proj.git
|
2006-01-15 00:00:32 +00:00
|
|
|
------------
|
|
|
|
|
|
2022-09-07 08:27:04 +00:00
|
|
|
CONFIGURATION
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
include::includes/cmd-config-section-all.txt[]
|
|
|
|
|
|
docs: add CONFIGURATION sections that fuzzy map to built-ins
Add a CONFIGURATION section to the documentation of various built-ins,
for those cases where the relevant config/NAME.txt doesn't map only to
one git-NAME.txt. In particular:
* config/blame.txt: used by git-{blame,annotate}.txt. Since the
git-annotate(1) documentation refers to git-blame(1) don't add a
"CONFIGURATION" section to git-annotate(1), only to git-blame(1).
* config/checkout.txt: maps to both git-checkout.txt and
git-switch.txt (but nothing else).
* config/init.txt: should be included in git-init(1) and
git-clone(1).
* config/column.txt: We should ideally mention the relevant subset of
this in git-{branch,clean,status,tag}.txt, but let's punt on it for
now. We will when we eventually split these sort of files into
e.g. config/column.txt and
config/column/{branch,clean,status,tag}.txt, with the former
including the latter set.
Things that are being left out, and why:
* config/{remote,remotes,credential}.txt: Configuration that affects
how we talk to remote repositories is harder to untangle. We'll need
to include some of this in git-{fetch,remote,push,ls-remote}.txt
etc., but some of those only use a small subset of these
options. Let's leave this for now.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Reviewed-by: Matheus Tavares <matheus.bernardino@usp.br>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2022-09-07 08:27:05 +00:00
|
|
|
include::config/init.txt[]
|
|
|
|
|
|
2022-09-07 08:27:04 +00:00
|
|
|
include::config/clone.txt[]
|
|
|
|
|
|
2006-01-15 00:00:32 +00:00
|
|
|
|
2005-07-14 03:25:54 +00:00
|
|
|
GIT
|
|
|
|
|
---
|
2008-06-06 07:07:32 +00:00
|
|
|
Part of the linkgit:git[1] suite
|