mirror of
https://github.com/git/git.git
synced 2024-11-05 16:52:59 +01:00
97716d217c
Add a --prune-tags option to git-fetch, along with fetch.pruneTags
config option and a -P shorthand (-p is --prune). This allows for
doing any of:
git fetch -p -P
git fetch --prune --prune-tags
git fetch -p -P origin
git fetch --prune --prune-tags origin
Or simply:
git config fetch.prune true &&
git config fetch.pruneTags true &&
git fetch
Instead of the much more verbose:
git fetch --prune origin 'refs/tags/*:refs/tags/*' '+refs/heads/*:refs/remotes/origin/*'
Before this feature it was painful to support the use-case of pulling
from a repo which is having both its branches *and* tags deleted
regularly, and have our local references to reflect upstream.
At work we create deployment tags in the repo for each rollout, and
there's *lots* of those, so they're archived within weeks for
performance reasons.
Without this change it's hard to centrally configure such repos in
/etc/gitconfig (on servers that are only used for working with
them). You need to set fetch.prune=true globally, and then for each
repo:
git -C {} config --replace-all remote.origin.fetch "refs/tags/*:refs/tags/*" "^\+*refs/tags/\*:refs/tags/\*$"
Now I can simply set fetch.pruneTags=true in /etc/gitconfig as well,
and users running "git pull" will automatically get the pruning
semantics I want.
Even though "git remote" has corresponding "prune" and "update
--prune" subcommands I'm intentionally not adding a corresponding
prune-tags or "update --prune --prune-tags" mode to that command.
It's advertised (as noted in my recent "git remote doc: correct
dangerous lies about what prune does") as only modifying remote
tracking references, whereas any --prune-tags option is always going
to modify what from the user's perspective is a local copy of the tag,
since there's no such thing as a remote tracking tag.
Ideally add_prune_tags_to_fetch_refspec() would be something that
would use ALLOC_GROW() to grow the 'fetch` member of the 'remote'
struct. Instead I'm realloc-ing remote->fetch and adding the
tag_refspec to the end.
The reason is that parse_{fetch,push}_refspec which allocate the
refspec (ultimately remote->fetch) struct are called many places that
don't have access to a 'remote' struct. It would be hard to change all
their callsites to be amenable to carry around the bookkeeping
variables required for dynamic allocation.
All the other callers of the API first incrementally construct the
string version of the refspec in remote->fetch_refspec via
add_fetch_refspec(), before finally calling parse_fetch_refspec() via
some variation of remote_get().
It's less of a pain to deal with the one special case that needs to
modify already constructed refspecs than to chase down and change all
the other callsites. The API I'm adding is intentionally not
generalized because if we add more of these we'd probably want to
re-visit how this is done.
See my "Re: [BUG] git remote prune removes local tags, depending on
fetch config" (87po6ahx87.fsf@evledraar.gmail.com;
https://public-inbox.org/git/87po6ahx87.fsf@evledraar.gmail.com/) for
more background info.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
197 lines
6.8 KiB
Text
197 lines
6.8 KiB
Text
--all::
|
|
Fetch all remotes.
|
|
|
|
-a::
|
|
--append::
|
|
Append ref names and object names of fetched refs to the
|
|
existing contents of `.git/FETCH_HEAD`. Without this
|
|
option old data in `.git/FETCH_HEAD` will be overwritten.
|
|
|
|
--depth=<depth>::
|
|
Limit fetching to the specified number of commits from the tip of
|
|
each remote branch history. If fetching to a 'shallow' repository
|
|
created by `git clone` with `--depth=<depth>` option (see
|
|
linkgit:git-clone[1]), deepen or shorten the history to the specified
|
|
number of commits. Tags for the deepened commits are not fetched.
|
|
|
|
--deepen=<depth>::
|
|
Similar to --depth, except it specifies the number of commits
|
|
from the current shallow boundary instead of from the tip of
|
|
each remote branch history.
|
|
|
|
--shallow-since=<date>::
|
|
Deepen or shorten the history of a shallow repository to
|
|
include all reachable commits after <date>.
|
|
|
|
--shallow-exclude=<revision>::
|
|
Deepen or shorten the history of a shallow repository to
|
|
exclude commits reachable from a specified remote branch or tag.
|
|
This option can be specified multiple times.
|
|
|
|
--unshallow::
|
|
If the source repository is complete, convert a shallow
|
|
repository to a complete one, removing all the limitations
|
|
imposed by shallow repositories.
|
|
+
|
|
If the source repository is shallow, fetch as much as possible so that
|
|
the current repository has the same history as the source repository.
|
|
|
|
--update-shallow::
|
|
By default when fetching from a shallow repository,
|
|
`git fetch` refuses refs that require updating
|
|
.git/shallow. This option updates .git/shallow and accept such
|
|
refs.
|
|
|
|
ifndef::git-pull[]
|
|
--dry-run::
|
|
Show what would be done, without making any changes.
|
|
endif::git-pull[]
|
|
|
|
-f::
|
|
--force::
|
|
When 'git fetch' is used with `<rbranch>:<lbranch>`
|
|
refspec, it refuses to update the local branch
|
|
`<lbranch>` unless the remote branch `<rbranch>` it
|
|
fetches is a descendant of `<lbranch>`. This option
|
|
overrides that check.
|
|
|
|
-k::
|
|
--keep::
|
|
Keep downloaded pack.
|
|
|
|
ifndef::git-pull[]
|
|
--multiple::
|
|
Allow several <repository> and <group> arguments to be
|
|
specified. No <refspec>s may be specified.
|
|
|
|
-p::
|
|
--prune::
|
|
Before fetching, remove any remote-tracking references that no
|
|
longer exist on the remote. Tags are not subject to pruning
|
|
if they are fetched only because of the default tag
|
|
auto-following or due to a --tags option. However, if tags
|
|
are fetched due to an explicit refspec (either on the command
|
|
line or in the remote configuration, for example if the remote
|
|
was cloned with the --mirror option), then they are also
|
|
subject to pruning. Supplying `--prune-tags` is a shorthand for
|
|
providing the tag refspec.
|
|
+
|
|
See the PRUNING section below for more details.
|
|
|
|
-P::
|
|
--prune-tags::
|
|
Before fetching, remove any local tags that no longer exist on
|
|
the remote if `--prune` is enabled. This option should be used
|
|
more carefully, unlike `--prune` it will remove any local
|
|
references (local tags) that have been created. This option is
|
|
a shorthand for providing the explicit tag refspec along with
|
|
`--prune`, see the discussion about that in its documentation.
|
|
+
|
|
See the PRUNING section below for more details.
|
|
|
|
endif::git-pull[]
|
|
|
|
ifndef::git-pull[]
|
|
-n::
|
|
endif::git-pull[]
|
|
--no-tags::
|
|
By default, tags that point at objects that are downloaded
|
|
from the remote repository are fetched and stored locally.
|
|
This option disables this automatic tag following. The default
|
|
behavior for a remote may be specified with the remote.<name>.tagOpt
|
|
setting. See linkgit:git-config[1].
|
|
|
|
ifndef::git-pull[]
|
|
--refmap=<refspec>::
|
|
When fetching refs listed on the command line, use the
|
|
specified refspec (can be given more than once) to map the
|
|
refs to remote-tracking branches, instead of the values of
|
|
`remote.*.fetch` configuration variables for the remote
|
|
repository. See section on "Configured Remote-tracking
|
|
Branches" for details.
|
|
|
|
-t::
|
|
--tags::
|
|
Fetch all tags from the remote (i.e., fetch remote tags
|
|
`refs/tags/*` into local tags with the same name), in addition
|
|
to whatever else would otherwise be fetched. Using this
|
|
option alone does not subject tags to pruning, even if --prune
|
|
is used (though tags may be pruned anyway if they are also the
|
|
destination of an explicit refspec; see `--prune`).
|
|
|
|
--recurse-submodules[=yes|on-demand|no]::
|
|
This option controls if and under what conditions new commits of
|
|
populated submodules should be fetched too. It can be used as a
|
|
boolean option to completely disable recursion when set to 'no' or to
|
|
unconditionally recurse into all populated submodules when set to
|
|
'yes', which is the default when this option is used without any
|
|
value. Use 'on-demand' to only recurse into a populated submodule
|
|
when the superproject retrieves a commit that updates the submodule's
|
|
reference to a commit that isn't already in the local submodule
|
|
clone.
|
|
|
|
-j::
|
|
--jobs=<n>::
|
|
Number of parallel children to be used for fetching submodules.
|
|
Each will fetch from different submodules, such that fetching many
|
|
submodules will be faster. By default submodules will be fetched
|
|
one at a time.
|
|
|
|
--no-recurse-submodules::
|
|
Disable recursive fetching of submodules (this has the same effect as
|
|
using the `--recurse-submodules=no` option).
|
|
|
|
--submodule-prefix=<path>::
|
|
Prepend <path> to paths printed in informative messages
|
|
such as "Fetching submodule foo". This option is used
|
|
internally when recursing over submodules.
|
|
|
|
--recurse-submodules-default=[yes|on-demand]::
|
|
This option is used internally to temporarily provide a
|
|
non-negative default value for the --recurse-submodules
|
|
option. All other methods of configuring fetch's submodule
|
|
recursion (such as settings in linkgit:gitmodules[5] and
|
|
linkgit:git-config[1]) override this option, as does
|
|
specifying --[no-]recurse-submodules directly.
|
|
endif::git-pull[]
|
|
|
|
-u::
|
|
--update-head-ok::
|
|
By default 'git fetch' refuses to update the head which
|
|
corresponds to the current branch. This flag disables the
|
|
check. This is purely for the internal use for 'git pull'
|
|
to communicate with 'git fetch', and unless you are
|
|
implementing your own Porcelain you are not supposed to
|
|
use it.
|
|
|
|
--upload-pack <upload-pack>::
|
|
When given, and the repository to fetch from is handled
|
|
by 'git fetch-pack', `--exec=<upload-pack>` is passed to
|
|
the command to specify non-default path for the command
|
|
run on the other end.
|
|
|
|
ifndef::git-pull[]
|
|
-q::
|
|
--quiet::
|
|
Pass --quiet to git-fetch-pack and silence any other internally
|
|
used git commands. Progress is not reported to the standard error
|
|
stream.
|
|
|
|
-v::
|
|
--verbose::
|
|
Be verbose.
|
|
endif::git-pull[]
|
|
|
|
--progress::
|
|
Progress status is reported on the standard error stream
|
|
by default when it is attached to a terminal, unless -q
|
|
is specified. This flag forces progress status even if the
|
|
standard error stream is not directed to a terminal.
|
|
|
|
-4::
|
|
--ipv4::
|
|
Use IPv4 addresses only, ignoring IPv6 addresses.
|
|
|
|
-6::
|
|
--ipv6::
|
|
Use IPv6 addresses only, ignoring IPv4 addresses.
|