X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Furls.txt;h=4f667382ec1b3a93871c8b2beb31111278ec27b8;hb=27ee189163070f53a87e033171a45520f70b242e;hp=745f9677d005b522f52496339abd5afc4267a815;hpb=bff898b894815ad291b35d213f1c022d1d16a9b9;p=git.git diff --git a/Documentation/urls.txt b/Documentation/urls.txt index 745f9677d..4f667382e 100644 --- a/Documentation/urls.txt +++ b/Documentation/urls.txt @@ -10,16 +10,18 @@ to name the remote repository: - https://host.xz/path/to/repo.git/ - git://host.xz/path/to/repo.git/ - git://host.xz/~user/path/to/repo.git/ +- ssh://{startsb}user@{endsb}host.xz{startsb}:port{endsb}/path/to/repo.git/ - ssh://{startsb}user@{endsb}host.xz/path/to/repo.git/ - ssh://{startsb}user@{endsb}host.xz/~user/path/to/repo.git/ - ssh://{startsb}user@{endsb}host.xz/~/path/to/repo.git =============================================================== -SSH is the default transport protocol. You can optionally specify -which user to log-in as, and an alternate, scp-like syntax is also -supported. Both syntaxes support username expansion, -as does the native git protocol. The following three are -identical to the last three above, respectively: +SSH is the default transport protocol over the network. You can +optionally specify which user to log-in as, and an alternate, +scp-like syntax is also supported. Both syntaxes support +username expansion, as does the native git protocol, but +only the former supports port specification. The following +three are identical to the last three above, respectively: =============================================================== - {startsb}user@{endsb}host.xz:/path/to/repo.git/ @@ -27,62 +29,18 @@ identical to the last three above, respectively: - {startsb}user@{endsb}host.xz:path/to/repo.git =============================================================== -To sync with a local directory, use: +To sync with a local directory, you can use: =============================================================== - /path/to/repo.git/ +- file:///path/to/repo.git/ =============================================================== -REMOTES -------- +ifndef::git-clone[] +They are mostly equivalent, except when cloning. See +gitlink:git-clone[1] for details. +endif::git-clone[] -In addition to the above, as a short-hand, the name of a -file in `$GIT_DIR/remotes` directory can be given; the -named file should be in the following format: - ------------- - URL: one of the above URL format - Push: - Pull: - ------------- - -Then such a short-hand is specified in place of - without parameters on the command -line, specified on `Push:` lines or `Pull:` -lines are used for `git-push` and `git-fetch`/`git-pull`, -respectively. Multiple `Push:` and `Pull:` lines may -be specified for additional branch mappings. - -Or, equivalently, in the `$GIT_DIR/config` (note the use -of `fetch` instead of `Pull:`): - ------------- - [remote ""] - url = - push = - fetch = - ------------- - -The name of a file in `$GIT_DIR/branches` directory can be -specified as an older notation short-hand; the named -file should contain a single line, a URL in one of the -above formats, optionally followed by a hash `#` and the -name of remote head (URL fragment notation). -`$GIT_DIR/branches/` file that stores a -without the fragment is equivalent to have this in the -corresponding file in the `$GIT_DIR/remotes/` directory. - ------------- - URL: - Pull: refs/heads/master: - ------------- - -while having `#` is equivalent to - ------------- - URL: - Pull: refs/heads/: ------------- +ifdef::git-clone[] +They are equivalent, except the former implies --local option. +endif::git-clone[]