fetch-options.txt: simplify ifdef/ifndef/endif usage
[git/git-svn.git] / Documentation / fetch-options.txt
blobf0ef7d02a5dc6c40eb9aab706e0c43f467b3f8a6
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 or shorten the history of a 'shallow' repository created by
12         `git clone` with `--depth=<depth>` option (see linkgit:git-clone[1])
13         to the specified number of commits from the tip of each remote
14         branch history. Tags for the deepened commits are not fetched.
16 --unshallow::
17         Convert a shallow repository to a complete one, removing all
18         the limitations imposed by shallow repositories.
20 ifndef::git-pull[]
21 --dry-run::
22         Show what would be done, without making any changes.
23 endif::git-pull[]
25 -f::
26 --force::
27         When 'git fetch' is used with `<rbranch>:<lbranch>`
28         refspec, it refuses to update the local branch
29         `<lbranch>` unless the remote branch `<rbranch>` it
30         fetches is a descendant of `<lbranch>`.  This option
31         overrides that check.
33 -k::
34 --keep::
35         Keep downloaded pack.
37 ifndef::git-pull[]
38 --multiple::
39         Allow several <repository> and <group> arguments to be
40         specified. No <refspec>s may be specified.
42 -p::
43 --prune::
44         After fetching, remove any remote-tracking references that no
45         longer exist on the remote.  Tags are not subject to pruning
46         if they are fetched only because of the default tag
47         auto-following or due to a --tags option.  However, if tags
48         are fetched due to an explicit refspec (either on the command
49         line or in the remote configuration, for example if the remote
50         was cloned with the --mirror option), then they are also
51         subject to pruning.
52 endif::git-pull[]
54 ifndef::git-pull[]
55 -n::
56 endif::git-pull[]
57 --no-tags::
58         By default, tags that point at objects that are downloaded
59         from the remote repository are fetched and stored locally.
60         This option disables this automatic tag following. The default
61         behavior for a remote may be specified with the remote.<name>.tagopt
62         setting. See linkgit:git-config[1].
64 ifndef::git-pull[]
65 -t::
66 --tags::
67         Fetch all tags from the remote (i.e., fetch remote tags
68         `refs/tags/*` into local tags with the same name), in addition
69         to whatever else would otherwise be fetched.  Using this
70         option alone does not subject tags to pruning, even if --prune
71         is used (though tags may be pruned anyway if they are also the
72         destination of an explicit refspec; see '--prune').
74 --recurse-submodules[=yes|on-demand|no]::
75         This option controls if and under what conditions new commits of
76         populated submodules should be fetched too. It can be used as a
77         boolean option to completely disable recursion when set to 'no' or to
78         unconditionally recurse into all populated submodules when set to
79         'yes', which is the default when this option is used without any
80         value. Use 'on-demand' to only recurse into a populated submodule
81         when the superproject retrieves a commit that updates the submodule's
82         reference to a commit that isn't already in the local submodule
83         clone.
85 --no-recurse-submodules::
86         Disable recursive fetching of submodules (this has the same effect as
87         using the '--recurse-submodules=no' option).
89 --submodule-prefix=<path>::
90         Prepend <path> to paths printed in informative messages
91         such as "Fetching submodule foo".  This option is used
92         internally when recursing over submodules.
94 --recurse-submodules-default=[yes|on-demand]::
95         This option is used internally to temporarily provide a
96         non-negative default value for the --recurse-submodules
97         option.  All other methods of configuring fetch's submodule
98         recursion (such as settings in linkgit:gitmodules[5] and
99         linkgit:git-config[1]) override this option, as does
100         specifying --[no-]recurse-submodules directly.
101 endif::git-pull[]
103 -u::
104 --update-head-ok::
105         By default 'git fetch' refuses to update the head which
106         corresponds to the current branch.  This flag disables the
107         check.  This is purely for the internal use for 'git pull'
108         to communicate with 'git fetch', and unless you are
109         implementing your own Porcelain you are not supposed to
110         use it.
112 --upload-pack <upload-pack>::
113         When given, and the repository to fetch from is handled
114         by 'git fetch-pack', '--exec=<upload-pack>' is passed to
115         the command to specify non-default path for the command
116         run on the other end.
118 ifndef::git-pull[]
119 -q::
120 --quiet::
121         Pass --quiet to git-fetch-pack and silence any other internally
122         used git commands. Progress is not reported to the standard error
123         stream.
125 -v::
126 --verbose::
127         Be verbose.
128 endif::git-pull[]
130 --progress::
131         Progress status is reported on the standard error stream
132         by default when it is attached to a terminal, unless -q
133         is specified. This flag forces progress status even if the
134         standard error stream is not directed to a terminal.