summaryrefslogtreecommitdiff
path: root/Documentation/urls.txt
diff options
context:
space:
mode:
authorJ. Bruce Fields <bfields@fieldses.org>2006-02-05 22:43:47 (GMT)
committerJunio C Hamano <junkio@cox.net>2006-02-07 05:14:55 (GMT)
commit3598a308086d4a41cab1e941df7763f2004e53c5 (patch)
tree6fe4f307662f0b12f568293b148d1bdbcbaf9dac /Documentation/urls.txt
parent4462731e0597c31c68466601a5d74b2edb145d6d (diff)
downloadgit-3598a308086d4a41cab1e941df7763f2004e53c5.zip
git-3598a308086d4a41cab1e941df7763f2004e53c5.tar.gz
git-3598a308086d4a41cab1e941df7763f2004e53c5.tar.bz2
Docs: split up pull-fetch-param.txt
The push and pull man pages include a bunch of shared text from pull-fetch-param.txt. This simplifies maintenance somewhat, but there's actually quite a bit of text that applies only to one or the other. So, separate out the push- and pull/fetch-specific text into pull-fetch-param.txt and git-push.txt, then include the largest chunk of common stuff (the description of protocols and url's) from urls.txt. That cuts some irrelevant stuff from the man pages without making us duplicate too much. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation/urls.txt')
-rw-r--r--Documentation/urls.txt62
1 files changed, 62 insertions, 0 deletions
diff --git a/Documentation/urls.txt b/Documentation/urls.txt
new file mode 100644
index 0000000..e027c71
--- /dev/null
+++ b/Documentation/urls.txt
@@ -0,0 +1,62 @@
+One of the following notations can be used
+to name the remote repository:
++
+===============================================================
+- rsync://host.xz/path/to/repo.git/
+- http://host.xz/path/to/repo.git/
+- https://host.xz/path/to/repo.git/
+- git://host.xz/path/to/repo.git/
+- git://host.xz/~user/path/to/repo.git/
+- ssh://host.xz/path/to/repo.git/
+- ssh://host.xz/~user/path/to/repo.git/
+- ssh://host.xz/~/path/to/repo.git
+===============================================================
++
+SSH Is the default transport protocol and also supports an
+scp-like syntax. Both syntaxes support username expansion,
+as does the native git protocol. The following three are
+identical to the last three above, respectively:
++
+===============================================================
+- host.xz:/path/to/repo.git/
+- host.xz:~user/path/to/repo.git/
+- host.xz:path/to/repo.git
+===============================================================
++
+To sync with a local directory, use:
++
+===============================================================
+- /path/to/repo.git/
+===============================================================
++
+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: <refspec>
+ Pull: <refspec>
++
+When such a short-hand is specified in place of
+<repository> without <refspec> parameters on the command
+line, <refspec> specified on `Push:` lines or `Pull:`
+lines are used for `git-push` and `git-fetch`/`git-pull`,
+respectively. Multiple `Push:` and and `Pull:` lines may
+be specified for additional branch mappings.
++
+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/<remote>` file that stores a <url>
+without the fragment is equivalent to have this in the
+corresponding file in the `$GIT_DIR/remotes/` directory.
++
+ URL: <url>
+ Pull: refs/heads/master:<remote>
++
+while having `<url>#<head>` is equivalent to
++
+ URL: <url>
+ Pull: refs/heads/<head>:<remote>