builtin-fetch: add --prune option
[git/git.git] / Documentation / fetch-options.txt
CommitLineData
9c4a036b
BG
1--all::
2 Fetch all remotes.
3
3240240f
SB
4-a::
5--append::
93d69d86
JL
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.
9
6b276e19
JA
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.
2c620a1a 14
3240240f
SB
15-f::
16--force::
ba020ef5 17 When 'git-fetch' is used with `<rbranch>:<lbranch>`
a3e3dc46
JH
18 refspec, it refuses to update the local branch
19 `<lbranch>` unless the remote branch `<rbranch>` it
20 fetches is a descendant of `<lbranch>`. This option
21 overrides that check.
93d69d86 22
6b276e19
JA
23-k::
24--keep::
25 Keep downloaded pack.
26
16679e37
BG
27ifndef::git-pull[]
28--multiple::
29 Allow several <repository> and <group> arguments to be
30 specified. No <refspec>s may be specified.
f360d844
JS
31
32--prune::
33 After fetching, remove any remote tracking branches which
34 no longer exist on the remote.
16679e37
BG
35endif::git-pull[]
36
10eb64f5 37ifdef::git-pull[]
3240240f 38--no-tags::
10eb64f5
MV
39endif::git-pull[]
40ifndef::git-pull[]
3240240f
SB
41-n::
42--no-tags::
10eb64f5
MV
43endif::git-pull[]
44 By default, tags that point at objects that are downloaded
45 from the remote repository are fetched and stored locally.
46 This option disables this automatic tag following.
03febf99 47
3240240f
SB
48-t::
49--tags::
03febf99
JH
50 Most of the tags are fetched automatically as branch
51 heads are downloaded, but tags that do not point at
52 objects reachable from the branch heads that are being
53 tracked will not be fetched by this mechanism. This
54 flag lets all tags and their associated objects be
55 downloaded.
93d69d86 56
3240240f
SB
57-u::
58--update-head-ok::
ba020ef5 59 By default 'git-fetch' refuses to update the head which
93d69d86 60 corresponds to the current branch. This flag disables the
ba020ef5
JN
61 check. This is purely for the internal use for 'git-pull'
62 to communicate with 'git-fetch', and unless you are
a597fb0e
JH
63 implementing your own Porcelain you are not supposed to
64 use it.
03febf99 65
6b276e19
JA
66--upload-pack <upload-pack>::
67 When given, and the repository to fetch from is handled
68 by 'git-fetch-pack', '--exec=<upload-pack>' is passed to
69 the command to specify non-default path for the command
70 run on the other end.
71
72ifndef::git-pull[]
73-q::
74--quiet::
75 Pass --quiet to git-fetch-pack and silence any other internally
76 used git commands.
77
78-v::
79--verbose::
80 Be verbose.
81endif::git-pull[]