mirror of
https://github.com/git/git.git
synced 2024-11-26 03:14:50 +08:00
5ce4f4e3bf
Rewrite the first part of the document to explicitly show differences between the URLs that can be used with different transport protocols. Mention <transport>::<address> format to explicitly invoke a remote helper. Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com> Reviewed-by: Jonathan Nieder <jrnieder@gmail.com> Acked-by: Sverre Rabbelier <srabbelier@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
95 lines
3.0 KiB
Plaintext
95 lines
3.0 KiB
Plaintext
GIT URLS[[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 natively supports ssh, git, http, https, ftp, ftps, and rsync
|
|
protocols. The following syntaxes may be used with them:
|
|
|
|
- ssh://{startsb}user@{endsb}host.xz{startsb}:port{endsb}/path/to/repo.git/
|
|
- git://host.xz{startsb}:port{endsb}/path/to/repo.git/
|
|
- http{startsb}s{endsb}://host.xz{startsb}:port{endsb}/path/to/repo.git/
|
|
- ftp{startsb}s{endsb}://host.xz{startsb}:port{endsb}/path/to/repo.git/
|
|
- rsync://host.xz/path/to/repo.git/
|
|
|
|
An alternative scp-like syntax may also be used with the ssh protocol:
|
|
|
|
- {startsb}user@{endsb}host.xz:path/to/repo.git/
|
|
|
|
The ssh and git protocols additionally support ~username expansion:
|
|
|
|
- ssh://{startsb}user@{endsb}host.xz{startsb}:port{endsb}/~{startsb}user{endsb}/path/to/repo.git/
|
|
- git://host.xz{startsb}:port{endsb}/~{startsb}user{endsb}/path/to/repo.git/
|
|
- {startsb}user@{endsb}host.xz:/~{startsb}user{endsb}/path/to/repo.git/
|
|
|
|
For local respositories, 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 linkgit:git-clone[1] for
|
|
details.
|
|
endif::git-clone[]
|
|
|
|
ifdef::git-clone[]
|
|
These two syntaxes are mostly equivalent, except the former implies
|
|
--local option.
|
|
endif::git-clone[]
|
|
|
|
When git doesn't know how to handle a certain transport protocol, it
|
|
attempts to use the 'remote-<transport>' remote helper, if one
|
|
exists. To explicitly request a remote helper, the following syntax
|
|
may be used:
|
|
|
|
- <transport>::<address>
|
|
|
|
where <address> may be a path, a server and path, or an arbitrary
|
|
URL-like string recognized by the specific remote helper being
|
|
invoked. See linkgit:git-remote-helpers[1] 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 "<actual url base>"]
|
|
insteadOf = <other url base>
|
|
------------
|
|
|
|
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 "<actual url base>"]
|
|
pushInsteadOf = <other url base>
|
|
------------
|
|
|
|
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.
|