Integrate changes from a remote repository into the current branch.
First, gitpull runs gitfetch with the same arguments (excluding merge options) to fetch remote branch(es). Then it decides which remote branch to integrate: if you run gitpull with no arguments this defaults to the upstream for the current branch. Then it integrates that branch into the current branch.
There are 4 main options for integrating the remote branch:
gitpull--ff-only will only do "fast-forward" updates: it fails if your local branch has diverged from the remote branch. This is the default.
gitpull--rebase runs gitrebase
gitpull--no-rebase runs gitmerge.
gitpull--squash runs gitmerge--squash
You can also set the configuration options pull.rebase, pull.squash, or pull.ff with your preferred behaviour.
If there’s a merge conflict during the merge or rebase that you don’t want to handle, you can safely abort it with gitmerge--abort or gitrebase--abort.
OPTIONS -------
\<repository>
The "remote" repository to pull from. This can be either a URL (see the section GIT URLS below) or the name of a remote (see the section REMOTES below).
Defaults to the configured upstream for the current branch, or origin. See UPSTREAM BRANCHES below for more on how to configure upstreams.
\<refspec>
Which branch or other reference(s) to fetch and integrate into the current branch, for example main in gitpulloriginmain. Defaults to the configured upstream for the current branch.
This can be a branch, tag, or other collection of reference(s). See <refspec> below under "Options related to fetching" for the full syntax, and DEFAULT BEHAVIOUR below for how gitpull uses this argument to determine which remote branch to integrate.
-q
--quiet
This is passed to both underlying git-fetch to squelch reporting of during transfer, and underlying git-merge to squelch output during merging.
-v
--verbose
Pass --verbose to git-fetch and git-merge.
--recurse-submodules[=(yes|on-demand|no)]
--no-recurse-submodules
This option controls if new commits of populated submodules should be fetched, and if the working trees of active submodules should be updated, too (see git-fetch, git-config and gitmodules).
If the checkout is done via rebase, local submodule commits are rebased as well.
If the update is done via merge, the submodule conflicts are resolved and checked out.
Options related to merging \~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~~
`--commit`
`--no-commit`
Perform the merge and commit the result. This option can be used to override `--no-commit`.
ifdef
git-pull\[\] Only useful when merging.
endif
git-pull\[\]
With `--no-commit` perform the merge and stop just before creating a merge commit, to give the user a chance to inspect and further tweak the merge result before committing.
Note that fast-forward updates do not create a merge commit and therefore there is no way to stop those merges with `--no-commit`. Thus, if you want to ensure your branch is not changed or updated by the merge command, use `--no-ff` with `--no-commit`.
`--edit`
`-e`
`--no-edit`
Invoke an editor before committing successful mechanical merge to further edit the auto-generated merge message, so that the user can explain and justify the merge. The `--no-edit` option can be used to accept the auto-generated message (this is generally discouraged).
ifndef
git-pull\[\] The `--edit` (or `-e`) option is still useful if you are giving a draft message with the `-m` option from the command line and want to edit it in the editor.
endif
git-pull\[\]
Older scripts may depend on the historical behaviour of not allowing the user to edit the merge log message. They will see an editor opened when they run `git` `merge`. To make it easier to adjust such scripts to the updated behaviour, the environment variable `GIT_MERGE_AUTOEDIT` can be set to `no` at the beginning of them.
`--cleanup=`
This option determines how the merge message will be cleaned up before committing. See [git-commit](git-commit.md) for more details. In addition, if the *\* is given a value of `scissors`, scissors will be appended to `MERGE_MSG` before being passed on to the commit machinery in the case of a merge conflict.
ifdef
git-merge\[\]
`--ff`
`--no-ff`
`--ff-only`
Specifies how a merge is handled when the merged-in history is already a descendant of the current history. `--ff` is the default unless merging an annotated (and possibly signed) tag that is not stored in its natural place in the `refs/tags/` hierarchy, in which case `--no-ff` is assumed.
endif
git-merge\[\]
ifdef
git-pull\[\]
`--ff-only`
Only update to the new history if there is no divergent local history. This is the default when no method for reconciling divergent histories is provided (via the `--rebase` flags).
`--ff`
`--no-ff`
When merging rather than rebasing, specifies how a merge is handled when the merged-in history is already a descendant of the current history. If merging is requested, `--ff` is the default unless merging an annotated (and possibly signed) tag that is not stored in its natural place in the `refs/tags/` hierarchy, in which case `--no-ff` is assumed.
endif
git-pull\[\]
With `--ff`, when possible resolve the merge as a fast-forward (only update the branch pointer to match the merged branch; do not create a merge commit). When not possible (when the merged-in history is not a descendant of the current history), create a merge commit.
With `--no-ff`, create a merge commit in all cases, even when the merge could instead be resolved as a fast-forward.
ifdef
git-merge\[\]
With `--ff-only`, resolve the merge as a fast-forward when possible. When not possible, refuse to merge and exit with a non-zero status.
endif
git-merge\[\]
`-S[]`
`--gpg-sign[=]`
`--no-gpg-sign`
GPG-sign the resulting merge commit. The *\* argument is optional and defaults to the committer identity; if specified, it must be stuck to the option without a space. `--no-gpg-sign` is useful to countermand both `commit.gpgSign` configuration variable, and earlier `--gpg-sign`.
`--log[=]`
`--no-log`
In addition to branch names, populate the log message with one-line descriptions from at most *\* actual commits that are being merged. See also [git-fmt-merge-msg](git-fmt-merge-msg.md).
ifdef
git-pull\[\] Only useful when merging.
endif
git-pull\[\]
With `--no-log` do not list one-line descriptions from the actual commits being merged.
include
signoff-option.adoc\[\]
`--stat`
`-n`
`--no-stat`
Show a diffstat at the end of the merge. The diffstat is also controlled by the configuration option merge.stat.
With `-n` or `--no-stat` do not show a diffstat at the end of the merge.
`--compact-summary`
Show a compact-summary at the end of the merge.
`--squash`
`--no-squash`
Produce the working tree and index state as if a real merge happened (except for the merge information), but do not actually make a commit, move the `HEAD`, or record `$GIT_DIR/MERGE_HEAD` (to cause the next `git` `commit` command to create a merge commit). This allows you to create a single commit on top of the current branch whose effect is the same as merging another branch (or more in case of an octopus).
With `--no-squash` perform the merge and commit the result. This option can be used to override `--squash`.
With `--squash`, `--commit` is not allowed, and will fail.
ifdef
git-pull\[\]
Only useful when merging.
endif
git-pull\[\]
`--verify`
`--no-verify`
By default, the pre-merge and commit-msg hooks are run. When `--no-verify` is given, these are bypassed. See also [githooks](githooks.md).
ifdef
git-pull\[\] Only useful when merging.
endif
git-pull\[\]
`-s` ``
`--strategy=`
Use the given merge strategy; can be supplied more than once to specify them in the order they should be tried. If there is no `-s` option, a built-in list of strategies is used instead (`ort` when merging a single head, `octopus` otherwise).
`-X` `
-r
--rebase[=(true|merges|false|interactive)] true;; rebase the current branch on top of the upstream branch after fetching. If there is a remote-tracking branch corresponding to the upstream branch and the upstream branch was rebased since last fetched, the rebase uses that information to avoid rebasing non-local changes. This is the default.
merges;; rebase using gitrebase--rebase-merges so that the local merge commits are included in the rebase (see git-rebase for details). false;; merge the upstream branch into the current branch. interactive;; enable the interactive mode of rebase.
\
See pull.rebase, branch.<name>.rebase and branch.autoSetupRebase in git-config if you want to make gitpull always use --rebase instead of merging. +
This is a potentially dangerous mode of operation. It rewrites history, which does not bode well when you published that history already. Do not use this option unless you have read git-rebase carefully.
--no-rebase
This is shorthand for --rebase=false.
Options related to fetching \~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~~
`--all`
`--no-all`
Fetch all remotes, except for the ones that have the `remote..skipFetchAll` configuration variable set. This overrides the configuration variable `fetch.all`.
`-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.
`--atomic`
Use an atomic transaction to update local refs. Either all refs are updated, or on error, no refs are updated.
`--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=` option (see [git-clone](git-clone.md)), deepen or shorten the history to the specified number of commits. Tags for the deepened commits are not fetched.
`--deepen=`
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=`
Deepen or shorten the history of a shallow repository to include all reachable commits after *\*.
`--shallow-exclude=`
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 accepts such refs.
`--negotiation-restrict=(|)`
`--negotiation-tip=(|)`
By default, Git will report, to the server, commits reachable from all local refs to find common commits in an attempt to reduce the size of the to-be-received packfile. If specified, Git will only report commits reachable from the given tips. This is useful to speed up fetches when the user knows which local ref is likely to have commits in common with the upstream ref being fetched.
`--negotiation-restrict` is the preferred name for this option; `--negotiation-tip` is accepted as a synonym.
This option may be specified more than once; if so, Git will report commits reachable from any of the given commits.
The argument to this option may be a glob on ref names, a ref, or the (possibly abbreviated) SHA-1 of a commit. Specifying a glob is equivalent to specifying this option multiple times, one for each matching ref name.
See also the `fetch.negotiationAlgorithm` and `push.negotiate` configuration variables documented in [git-config](git-config.md), and the `--negotiate-only` option below.
`--negotiation-include=(|)`
Ensure that the commits at the given tips are always sent as "have" lines during fetch negotiation, regardless of what the negotiation algorithm selects. This is useful to guarantee that common history reachable from specific refs is always considered, even when `--negotiation-restrict` restricts the set of tips or when the negotiation algorithm would otherwise skip them.
This option may be specified more than once; if so, each commit is sent unconditionally.
The argument may be an exact ref name (e.g. `refs/heads/release`), an object hash, or a glob pattern (e.g. `refs/heads/release/*`). The pattern syntax is the same as for `--negotiation-restrict`.
If `--negotiation-restrict` is used, the have set is first restricted by that option and then increased to include the tips specified by `--negotiation-include`.
If this option is not specified on the command line, then any `remote..negotiationInclude` config values for the current remote are used instead.
`--negotiate-only`
Do not fetch anything from the server, and instead print the ancestors of the provided `--negotiation-restrict=` arguments, which we have in common with the server.
This is incompatible with `--recurse-submodules=(yes|on-demand)`. Internally this is used to implement the `push.negotiate` option, see [git-config](git-config.md).
`--dry-run`
Show what would be done, without making any changes.
`--porcelain`
Print the output to standard output in an easy-to-parse format for scripts. See section OUTPUT in [git-fetch](git-fetch.md) for details.
This is incompatible with `--recurse-submodules=(yes|on-demand)` and takes precedence over the `fetch.output` config option.
`--filter=`
Use the partial clone feature and request that the server sends a subset of reachable objects according to a given object filter. When using `--filter`, the supplied *\* is used for the partial fetch.
If `--filter=auto` is used, the filter specification is determined automatically by combining the filter specifications advertised by the server for the promisor remotes that the client accepts (see [gitprotocol-v2](gitprotocol-v2.md) and the `promisor.acceptFromServer` configuration option in [git-config](git-config.md)).
For details on all other available filter specifications, see the `--filter=` option in [git-rev-list](git-rev-list.md).
For example, `--filter=blob:none` will filter out all blobs (file contents) until needed by Git. Also, `--filter=blob:limit=` will filter out all blobs of size at least *\*.
ifndef
git-pull\[\]
`--write-fetch-head`
`--no-write-fetch-head`
Write the list of remote refs fetched in the `FETCH_HEAD` file directly under `$GIT_DIR`. This is the default. Passing `--no-write-fetch-head` from the command line tells Git not to write the file. Under `--dry-run` option, the file is never written.
endif
git-pull\[\]
`-f`
`--force`
ifdef
git-pull\[\] When `git` `fetch` is used with `:` refspec, it may refuse to update the local branch as discussed in the *\* part of the [git-fetch](git-fetch.md) documentation.
endif
git-pull\[\]
ifndef
git-pull\[\] When `git` `fetch` is used with `:` refspec, it may refuse to update the local branch as discussed in the *\* part below.
endif
git-pull\[\] This option overrides that check.
`-k`
`--keep`
Keep downloaded pack.
ifndef
git-pull\[\]
`--multiple`
Allow several *\* and *\* arguments to be specified. No *\*s may be specified.
`--auto-maintenance`
`--no-auto-maintenance`
`--auto-gc`
`--no-auto-gc`
Run `git` `maintenance` `run` `--auto` at the end to perform automatic repository maintenance if needed. This is enabled by default.
`--write-commit-graph`
`--no-write-commit-graph`
Write a commit-graph after fetching. This overrides the config setting `fetch.writeCommitGraph`.
endif
git-pull\[\]
`--prefetch`
Modify the configured refspec to place all refs into the `refs/prefetch/` namespace. See the `prefetch` task in [git-maintenance](git-maintenance.md).
`-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.
ifndef
git-pull\[\]
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..tagOpt` setting. See [git-config](git-config.md).
ifndef
git-pull\[\]
`--refetch`
Instead of negotiating with the server to avoid transferring commits and associated objects that are already present locally, this option fetches all objects as a fresh clone would. Use this to reapply a partial clone filter from configuration or using `--filter=` when the filter definition has changed. Automatic post-fetch maintenance will perform object database pack consolidation to remove any duplicate objects.
endif
git-pull\[\]
`--refmap=`
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. Providing an empty *\* to the `--refmap` option causes Git to ignore the configured refspecs and rely entirely on the refspecs supplied as command-line arguments. 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`).
ifndef
git-pull\[\]
`--recurse-submodules[=(yes|on-demand|no)]`
Control if and under what conditions new commits of submodules should be fetched too. When recursing through submodules, `git` `fetch` always attempts to fetch "changed" submodules, that is, a submodule that has commits that are referenced by a newly fetched superproject commit but are missing in the local submodule clone. A changed submodule can be fetched as long as it is present locally e.g. in `$GIT_DIR/modules/` (see [gitsubmodules](gitsubmodules.md)); if the upstream adds a new submodule, that submodule cannot be fetched until it is cloned e.g. by `git` `submodule` `update`.
When set to `on-demand`, only changed submodules are fetched. When set to `yes`, all populated submodules are fetched and submodules that are both unpopulated and changed are fetched. When set to `no`, submodules are never fetched.
When unspecified, this uses the value of `fetch.recurseSubmodules` if it is set (see [git-config](git-config.md)), defaulting to `on-demand` if unset. When this option is used without any value, it defaults to `yes`.
endif
git-pull\[\]
`-j` ``
`--jobs=`
Parallelize all forms of fetching up to *\* jobs at a time.
A value of 0 will use some reasonable default.
If the `--multiple` option was specified, the different remotes will be fetched in parallel. If multiple submodules are fetched, they will be fetched in parallel. To control them independently, use the config settings `fetch.parallel` and `submodule.fetchJobs` (see [git-config](git-config.md)).
Typically, parallel recursive and multi-remote fetches will be faster. By default fetches are performed sequentially, not in parallel.
ifndef
git-pull\[\]
`--no-recurse-submodules`
Disable recursive fetching of submodules (this has the same effect as using the `--recurse-submodules=no` option).
endif
git-pull\[\]
`--set-upstream`
If the remote is fetched successfully, add upstream (tracking) reference, used by argument-less [git-pull](git-pull.md) and other commands. For more information, see `branch..merge` and `branch..remote` in [git-config](git-config.md).
ifndef
git-pull\[\]
`--submodule-prefix=`
Prepend *\* 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 [gitmodules](gitmodules.md) and [git-config](git-config.md)) override this option, as does specifying `--[no-]recurse-submodules` directly.
`-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.
endif
git-pull\[\]
`--upload-pack` ``
When given, and the repository to fetch from is handled by `git` `fetch-pack`, `--exec=` 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.
`-o` `
*\*
The "remote" repository that is the source of a fetch or pull operation. This parameter can be either a URL (see the section GIT URLS below) or the name of a remote (see the section REMOTES below).
ifndef
git-pull\[\]
*\*
A name referring to a list of repositories as the value of `remotes.` in the configuration file. (See [git-config](git-config.md)).
endif
git-pull\[\]
*\*
Specifies which refs to fetch and which local refs to update. When no *\*s appear on the command line, the refs to fetch are read from `remote..fetch` variables instead
ifndef
git-pull\[\] (see CONFIGURED REMOTE-TRACKING BRANCHES below).
endif
git-pull\[\]
ifdef
git-pull\[\] (see the section "CONFIGURED REMOTE-TRACKING BRANCHES" in [git-fetch](git-fetch.md)).
endif
git-pull\[\]
The format of a *\* parameter is an optional plus `+`, followed by the source *\*, followed by a colon `:`, followed by the destination *\*. The colon can be omitted when *\* is empty. *\* is typically a ref, or a glob pattern with a single `*` that is used to match a set of refs, but it can also be a fully spelled hex object name.
A *\* may contain a `*` in its *\* to indicate a simple pattern match. Such a refspec functions like a glob that matches any ref with the pattern. A pattern *\* must have one and only one `*` in both the *\* and *\*. It will map refs to the destination by replacing the `*` with the contents matched from the source.
If a refspec is prefixed by `^`, it will be interpreted as a negative refspec. Rather than specifying which refs to fetch or which local refs to update, such a refspec will instead specify refs to exclude. A ref will be considered to match if it matches at least one positive refspec, and does not match any negative refspec. Negative refspecs can be useful to restrict the scope of a pattern refspec so that it will not include specific refs. Negative refspecs can themselves be pattern refspecs. However, they may only contain a *\* and do not specify a *\*. Fully spelled out hex object names are also not supported.
`tag` `` means the same as `refs/tags/:refs/tags/`; it requests fetching everything up to the given tag.
The remote ref that matches *\* is fetched, and if *\* is not an empty string, an attempt is made to update the local ref that matches it.
Whether that update is allowed without `--force` depends on the ref namespace it’s being fetched to, the type of object being fetched, and whether the update is considered to be a fast-forward. Generally, the same rules apply for fetching as when pushing, see the `…` section of [git-push](git-push.md) for what those are. Exceptions to those rules particular to `git` `fetch` are noted below.
Until Git version 2.20, and unlike when pushing with [git-push](git-push.md), any updates to `refs/tags/*` would be accepted without `+` in the refspec (or `--force`). When fetching, we promiscuously considered all tag updates from a remote to be forced fetches. Since Git version 2.20, fetching to update `refs/tags/*` works the same way as when pushing. I.e. any updates will be rejected without `+` in the refspec (or `--force`).
Unlike when pushing with [git-push](git-push.md), any updates outside of `refs/{tags,heads}/*` will be accepted without `+` in the refspec (or `--force`), whether that’s swapping e.g. a tree object for a blob, or a commit for another commit that doesn’t have the previous commit as an ancestor etc.
Unlike when pushing with [git-push](git-push.md), there is no configuration which’ll amend these rules, and nothing like a `pre-fetch` hook analogous to the `pre-receive` hook.
As with pushing with [git-push](git-push.md), all of the rules described above about what’s not allowed as an update can be overridden by adding an optional leading `+` to a refspec (or using the `--force` command line option). The only exception to this is that no amount of forcing will make the `refs/heads/*` namespace accept a non-commit object.
When the remote branch you want to fetch is known to be rewound and rebased regularly, it is expected that its new tip will not be a descendant of its previous tip (as stored in your remote-tracking branch the last time you fetched). You would want to use the `+` sign to indicate non-fast-forward updates will be needed for such branches. There is no way to determine or declare that a branch will be made available in a repository with this behavior; the pulling user simply must know this is the expected usage pattern for a branch.
ifdef
git-pull\[\]
There is a difference between listing multiple *\* directly on `git` `pull` command line and having multiple `remote..fetch` entries in your configuration for a *\* and running a `git` `pull` command without any explicit *\* parameters. *\*s listed explicitly on the command line are always merged into the current branch after fetching. In other words, if you list more than one remote ref, `git` `pull` will create an Octopus merge. On the other hand, if you do not list any explicit *\* parameter on the command line, `git` `pull` will fetch all the *\*s it finds in the `remote..fetch` configuration and merge only the first *\* found into the current branch. This is because making an Octopus from remote refs is rarely done, while keeping track of multiple remote heads in one-go by fetching more than one is often useful.
endif
git-pull\[\]
GIT URLS ----------------
In general, URLs contain information about the transport protocol, the address of the remote server, and the path to the repository. Depending on the transport protocol, some of this information may be absent.
Git supports ssh, git, http, and https protocols (in addition, ftp and ftps can be used for fetching, but this is inefficient and deprecated; do not use them).
The native transport (i.e. `git://` URL) does no authentication and should be used with caution on unsecured networks.
The following syntaxes may be used with them:
- `ssh://[@][:]/`
- `git://[:]/`
- `http[s]://[:]/`
- `ftp[s]://[:]/`
An alternative scp-like syntax may also be used with the ssh protocol:
- `[@]:/`
This syntax is only recognized if there are no slashes before the first colon. This helps differentiate a local path that contains a colon. For example the local path `foo:bar` could be specified as an absolute path or `./foo:bar` to avoid being misinterpreted as an ssh url.
The ssh and git protocols additionally support `~` expansion:
- `ssh://[@][:]/~/`
- `git://[:]/~/`
- `[@]:~/`
For local repositories, also supported by Git natively, the following syntaxes may be used:
- `/path/to/repo.git/`
- `file:///path/to/repo.git/`
ifndef
git-clone\[\] These two syntaxes are mostly equivalent, except when cloning, when the former implies `--local` option. See [git-clone](git-clone.md) for details.
endif
git-clone\[\]
ifdef
git-clone\[\] These two syntaxes are mostly equivalent, except the former implies `--local` option.
endif
git-clone\[\]
`git` `clone`, `git` `fetch` and `git` `pull`, but not `git` `push`, will also accept a suitable bundle file. See [git-bundle](git-bundle.md).
When Git doesn’t know how to handle a certain transport protocol, it attempts to use the `remote-` remote helper, if one exists. To explicitly request a remote helper, the following syntax may be used:
- \`\
\\`
where *\* may be a path, a server and path, or an arbitrary URL-like string recognized by the specific remote helper being invoked. See [gitremote-helpers](gitremote-helpers.md) for details.
If there are a large number of similarly-named remote repositories and you want to use a different format for them (such that the URLs you use will be rewritten into URLs that work), you can create a configuration section of the form:
> \[url "*\*"\]\
> insteadOf = *\*
For example, with this:
[url "git://git.host.xz/"]
insteadOf = host.xz:/path/to/
insteadOf = work:
a URL like "work:repo.git" or like "host.xz:/path/to/repo.git" will be rewritten in any context that takes a URL to be "git://git.host.xz/repo.git".
If you want to rewrite URLs for push only, you can create a configuration section of the form:
> \[url "*\*"\]\
> pushInsteadOf = *\*
For example, with this:
[url "ssh://example.org/"]
pushInsteadOf = git://example.org/
a URL like "git://example.org/path/to/repo.git" will be rewritten to "ssh://example.org/path/to/repo.git" for pushes, but pulls will still use the original URL.
REMOTES ------------------
The name of one of the following can be used instead of a URL as *\* argument:
- a remote in the Git configuration file: `$GIT_DIR/config`,
- a file in the `$GIT_DIR/remotes` directory, or
- a file in the `$GIT_DIR/branches` directory.
All of these also allow you to omit the refspec from the command line because they each contain a refspec which git will use by default.
Named remote in configuration file \~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~~
You can choose to provide the name of a remote which you had previously configured using [git-remote](git-remote.md), [git-config](git-config.md) or even by a manual edit to the `$GIT_DIR/config` file. The URL of this remote will be used to access the repository. The refspec of this remote will be used by default when you do not provide a refspec on the command line. The entry in the config file would appear like this:
[remote ""]
url =
pushurl =
push =
fetch =
The *\* is used for pushes only. It is optional and defaults to *\*. Pushing to a remote affects all defined pushurls or all defined urls if no pushurls are defined. Fetch, however, will only fetch from the first defined url if multiple urls are defined.
Named file in `$GIT_DIR/remotes` \~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~~
You can choose to provide the name of a file in `$GIT_DIR/remotes`. The URL in this file will be used to access the repository. The refspec in this file will be used as default when you do not provide a refspec on the command line. This file should have the following format:
URL: one of the above URL formats
Push:
Pull:
`Push:` lines are used by `git` `push` and `Pull:` lines are used by `git` `pull` and `git` `fetch`. Multiple `Push:` and `Pull:` lines may be specified for additional branch mappings.
Named file in `$GIT_DIR/branches` \~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~\~~
You can choose to provide the name of a file in `$GIT_DIR/branches`. The URL in this file will be used to access the repository. This file should have the following format:
#
*\* is required; `#` is optional.
Depending on the operation, git will use one of the following refspecs, if you don’t provide one on the command line. *\* is the name of this file in `$GIT_DIR/branches` and *\* defaults to `master`.
git fetch uses:
refs/heads/:refs/heads/
git push uses:
HEAD:refs/heads/
UPSTREAM BRANCHES -----------------
Branches in Git can optionally have an upstream remote branch. Git defaults to using the upstream branch for remote operations, for example:
- It’s the default for `git` `pull` or `git` `fetch` with no arguments.
- It’s the default for `git` `push` with no arguments, with some exceptions. For example, you can use the `branch..pushRemote` option to push to a different remote than you pull from, and by default with `push.default=simple` the upstream branch you configure must have the same name.
- Various commands, including `git` `checkout` and `git` `status`, will show you how many commits have been added to your current branch and the upstream since you forked from it, for example "Your branch and ’origin/main’ have diverged, and have 2 and 3 different commits each respectively".
The upstream is stored in `.git/config`, in the “remote” and “merge” fields. For example, if `main`’s upstream is `origin/main`:
[branch "main"]
remote = origin
merge = refs/heads/main
You can set an upstream branch explicitly with `git` `push` `--set-upstream` `` `` but Git will often automatically set the upstream for you, for example:
- When you clone a repository, Git will automatically set the upstream for the default branch.
- If you have the `push.autoSetupRemote` configuration option set, `git` `push` will automatically set the upstream the first time you push a branch.
- Checking out a remote-tracking branch with `git` `checkout` `` will automatically create a local branch with that name and set the upstream to the remote branch.
Upstream branches are sometimes referred to as "tracking information", as in "set the branch’s tracking information".
MERGE STRATEGIES ----------------
The merge mechanism (`git` `merge` and `git` `pull` commands) allows the backend ’merge strategies’ to be chosen with `-s` option. Some strategies can also take their own options, which can be passed by giving `-X
DEFAULT BEHAVIOUR -----------------
Often people use gitpull without giving any parameter. Traditionally, this has been equivalent to saying gitpullorigin. However, when configuration branch.<name>.remote is present while on branch <name>, that value is used instead of origin.
In order to determine what URL to use to fetch from, the value of the configuration remote.<origin>.url is consulted and if there is not any such variable, the value on the URL: line in $GIT_DIR/remotes/<origin> is used.
In order to determine what remote branches to fetch (and optionally store in the remote-tracking branches) when the command is run without any refspec parameters on the command line, values of the configuration variable remote.<origin>.fetch are consulted, and if there aren’t any, $GIT_DIR/remotes/<origin> is consulted and its Pull: lines are used. In addition to the refspec formats described in the OPTIONS section, you can have a globbing refspec that looks like this:
refs/heads/*:refs/remotes/origin/*
A globbing refspec must have a non-empty RHS (i.e. must store what were fetched in remote-tracking branches), and its LHS and RHS must end with /*. The above specifies that all remote branches are tracked using remote-tracking branches in refs/remotes/origin/ hierarchy under the same name.
The rule to determine which remote branch to merge after fetching is a bit involved, in order not to break backward compatibility.
If explicit refspecs were given on the command line of gitpull, they are all merged.
When no refspec was given on the command line, then gitpull uses the refspec from the configuration or $GIT_DIR/remotes/<origin>. In such cases, the following rules apply:
If branch.<name>.merge configuration for the current branch \<name> exists, that is the name of the branch at the remote site that is merged.
If the refspec is a globbing one, nothing is merged.
Otherwise the remote branch of the first refspec is merged.
EXAMPLES --------
Update the remote-tracking branches for the repository you cloned from, then merge one of them into your current branch:
$ git pull
$ git pull origin
Normally the branch merged in is the HEAD of the remote repository, but the choice is determined by the branch.<name>.remote and branch.<name>.merge options; see git-config for details.
Merge into the current branch the remote branch next:
$ git pull origin next
This leaves a copy of next temporarily in FETCH_HEAD, and updates the remote-tracking branch origin/next. The same can be done by invoking fetch and merge:
$ git fetch origin
$ git merge origin/next
If you tried a pull which resulted in complex conflicts and would want to start over, you can recover with gitreset.
SECURITY -------- The fetch and push protocols are not designed to prevent one side from stealing data from the other repository that was not intended to be shared. If you have private data that you need to protect from a malicious peer, your best option is to store it in another repository. This applies to both clients and servers. In particular, namespaces on a server are not effective for read access control; you should only grant read access to a namespace to clients that you would trust with read access to the entire repository.
The known attack vectors are as follows:
1. The victim sends "have" lines advertising the IDs of objects it has that are not explicitly intended to be shared but can be used to optimize the transfer if the peer also has them. The attacker chooses an object ID X to steal and sends a ref to X, but isn’t required to send the content of X because the victim already has it. Now the victim believes that the attacker has X, and it sends the content of X back to the attacker later. (This attack is most straightforward for a client to perform on a server, by creating a ref to X in the namespace the client has access to and then fetching it. The most likely way for a server to perform it on a client is to "merge" X into a public branch and hope that the user does additional work on this branch and pushes it back to the server without noticing the merge.)
1. As in \#1, the attacker chooses an object ID X to steal. The victim sends an object Y that the attacker already has, and the attacker falsely claims to have X and not Y, so the victim sends Y as a delta against X. The delta reveals regions of X that are similar to Y to the attacker.
BUGS ---- Using --recurse-submodules can only fetch new commits in already checked out submodules right now. When e.g. upstream added a new submodule in the just fetched commits of the superproject the submodule itself cannot be fetched, making it impossible to check out that submodule later without having to do a fetch again. This is expected to be fixed in a future Git version.