Submodules: Add the "fetchRecurseSubmodules" config option
[git/jrn.git] / Documentation / fetch-options.txt
blob99e72d912488a73fffc816b2a006c453ab8b0e02
1 --all::
2         Fetch all remotes.
4 -a::
5 --append::
6         Append ref names and object names of fetched refs to the
7         existing contents of `.git/FETCH_HEAD`.  Without this
8         option old data in `.git/FETCH_HEAD` will be overwritten.
10 --depth=<depth>::
11         Deepen the history of a 'shallow' repository created by
12         `git clone` with `--depth=<depth>` option (see linkgit:git-clone[1])
13         by the specified number of commits.
15 ifndef::git-pull[]
16 --dry-run::
17         Show what would be done, without making any changes.
18 endif::git-pull[]
20 -f::
21 --force::
22         When 'git fetch' is used with `<rbranch>:<lbranch>`
23         refspec, it refuses to update the local branch
24         `<lbranch>` unless the remote branch `<rbranch>` it
25         fetches is a descendant of `<lbranch>`.  This option
26         overrides that check.
28 -k::
29 --keep::
30         Keep downloaded pack.
32 ifndef::git-pull[]
33 --multiple::
34         Allow several <repository> and <group> arguments to be
35         specified. No <refspec>s may be specified.
37 -p::
38 --prune::
39         After fetching, remove any remote tracking branches which
40         no longer exist on the remote.
41 endif::git-pull[]
43 ifdef::git-pull[]
44 --no-tags::
45 endif::git-pull[]
46 ifndef::git-pull[]
47 -n::
48 --no-tags::
49 endif::git-pull[]
50         By default, tags that point at objects that are downloaded
51         from the remote repository are fetched and stored locally.
52         This option disables this automatic tag following.
54 -t::
55 --tags::
56         Most of the tags are fetched automatically as branch
57         heads are downloaded, but tags that do not point at
58         objects reachable from the branch heads that are being
59         tracked will not be fetched by this mechanism.  This
60         flag lets all tags and their associated objects be
61         downloaded.
63 --[no-]recurse-submodules::
64         This option controls if new commits of all populated submodules should
65         be fetched too (see linkgit:git-config[1] and linkgit:gitmodules[5]).
67 ifndef::git-pull[]
68 --submodule-prefix=<path>::
69         Prepend <path> to paths printed in informative messages
70         such as "Fetching submodule foo".  This option is used
71         internally when recursing over submodules.
72 endif::git-pull[]
74 -u::
75 --update-head-ok::
76         By default 'git fetch' refuses to update the head which
77         corresponds to the current branch.  This flag disables the
78         check.  This is purely for the internal use for 'git pull'
79         to communicate with 'git fetch', and unless you are
80         implementing your own Porcelain you are not supposed to
81         use it.
83 --upload-pack <upload-pack>::
84         When given, and the repository to fetch from is handled
85         by 'git fetch-pack', '--exec=<upload-pack>' is passed to
86         the command to specify non-default path for the command
87         run on the other end.
89 ifndef::git-pull[]
90 -q::
91 --quiet::
92         Pass --quiet to git-fetch-pack and silence any other internally
93         used git commands. Progress is not reported to the standard error
94         stream.
96 -v::
97 --verbose::
98         Be verbose.
99 endif::git-pull[]
101 --progress::
102         Progress status is reported on the standard error stream
103         by default when it is attached to a terminal, unless -q
104         is specified. This flag forces progress status even if the
105         standard error stream is not directed to a terminal.