CodingGuidelines: add a note to help contributors catch some errors earlier.
[git/ydirson.git] / Documentation / fetch-options.txt
blob695696da1b6e78639014388e1d4ac8bf09a0e12d
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].
67 endif::git-pull[]
69 --[no-]recurse-submodules::
70         This option controls if new commits of all populated submodules should
71         be fetched too (see linkgit:git-config[1] and linkgit:gitmodules[5]).
73 ifndef::git-pull[]
74 --submodule-prefix=<path>::
75         Prepend <path> to paths printed in informative messages
76         such as "Fetching submodule foo".  This option is used
77         internally when recursing over submodules.
78 endif::git-pull[]
80 -u::
81 --update-head-ok::
82         By default 'git fetch' refuses to update the head which
83         corresponds to the current branch.  This flag disables the
84         check.  This is purely for the internal use for 'git pull'
85         to communicate with 'git fetch', and unless you are
86         implementing your own Porcelain you are not supposed to
87         use it.
89 --upload-pack <upload-pack>::
90         When given, and the repository to fetch from is handled
91         by 'git fetch-pack', '--exec=<upload-pack>' is passed to
92         the command to specify non-default path for the command
93         run on the other end.
95 ifndef::git-pull[]
96 -q::
97 --quiet::
98         Pass --quiet to git-fetch-pack and silence any other internally
99         used git commands. Progress is not reported to the standard error
100         stream.
102 -v::
103 --verbose::
104         Be verbose.
105 endif::git-pull[]
107 --progress::
108         Progress status is reported on the standard error stream
109         by default when it is attached to a terminal, unless -q
110         is specified. This flag forces progress status even if the
111         standard error stream is not directed to a terminal.