Win32: patch Windows environment on startup
[git/mingw/4msysgit/kblees.git] / Documentation / fetch-options.txt
blob39d326abc63af01d7cffe3d6f0c3df9279bc667e
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. The default
53         behavior for a remote may be specified with the remote.<name>.tagopt
54         setting. See linkgit:git-config[1].
56 ifndef::git-pull[]
57 -t::
58 --tags::
59         Most of the tags are fetched automatically as branch
60         heads are downloaded, but tags that do not point at
61         objects reachable from the branch heads that are being
62         tracked will not be fetched by this mechanism.  This
63         flag lets all tags and their associated objects be
64         downloaded. The default behavior for a remote may be
65         specified with the remote.<name>.tagopt setting. See
66         linkgit:git-config[1].
68 --recurse-submodules[=yes|on-demand|no]::
69         This option controls if and under what conditions new commits of
70         populated submodules should be fetched too. It can be used as a
71         boolean option to completely disable recursion when set to 'no' or to
72         unconditionally recurse into all populated submodules when set to
73         'yes', which is the default when this option is used without any
74         value. Use 'on-demand' to only recurse into a populated submodule
75         when the superproject retrieves a commit that updates the submodule's
76         reference to a commit that isn't already in the local submodule
77         clone.
79 --no-recurse-submodules::
80         Disable recursive fetching of submodules (this has the same effect as
81         using the '--recurse-submodules=no' option).
83 --submodule-prefix=<path>::
84         Prepend <path> to paths printed in informative messages
85         such as "Fetching submodule foo".  This option is used
86         internally when recursing over submodules.
88 --recurse-submodules-default=[yes|on-demand]::
89         This option is used internally to temporarily provide a
90         non-negative default value for the --recurse-submodules
91         option.  All other methods of configuring fetch's submodule
92         recursion (such as settings in linkgit:gitmodules[5] and
93         linkgit:git-config[1]) override this option, as does
94         specifying --[no-]recurse-submodules directly.
95 endif::git-pull[]
97 -u::
98 --update-head-ok::
99         By default 'git fetch' refuses to update the head which
100         corresponds to the current branch.  This flag disables the
101         check.  This is purely for the internal use for 'git pull'
102         to communicate with 'git fetch', and unless you are
103         implementing your own Porcelain you are not supposed to
104         use it.
106 --upload-pack <upload-pack>::
107         When given, and the repository to fetch from is handled
108         by 'git fetch-pack', '--exec=<upload-pack>' is passed to
109         the command to specify non-default path for the command
110         run on the other end.
112 ifndef::git-pull[]
113 -q::
114 --quiet::
115         Pass --quiet to git-fetch-pack and silence any other internally
116         used git commands. Progress is not reported to the standard error
117         stream.
119 -v::
120 --verbose::
121         Be verbose.
122 endif::git-pull[]
124 --progress::
125         Progress status is reported on the standard error stream
126         by default when it is attached to a terminal, unless -q
127         is specified. This flag forces progress status even if the
128         standard error stream is not directed to a terminal.