summaryrefslogtreecommitdiff
path: root/Documentation/urls-remotes.txt
diff options
context:
space:
mode:
authorAndrew Ruder <andy@aeruder.net>2007-07-04 22:21:36 (GMT)
committerJunio C Hamano <gitster@pobox.com>2007-07-06 04:43:48 (GMT)
commit37ba05619c76f9dbde35c418c6fc8af7bcda24c8 (patch)
treeb6c3f07f6d9bf3be5dee0ff6d0c0a6bedfaa954a /Documentation/urls-remotes.txt
parent114fd812f78ea375ee6782d4ff0203f3ae20b076 (diff)
downloadgit-37ba05619c76f9dbde35c418c6fc8af7bcda24c8.zip
git-37ba05619c76f9dbde35c418c6fc8af7bcda24c8.tar.gz
git-37ba05619c76f9dbde35c418c6fc8af7bcda24c8.tar.bz2
Add urls.txt to git-clone man page
Since git-clone is one of the many commands taking URLs to remote repositories as an argument, it should include the URL-types list from urls.txt. Split up urls.txt into urls.txt and urls-remotes.txt. The latter should be used by anything besides git-clone where a discussion of using .git/config and .git/remotes/ to name URLs just doesn't make as much sense. Signed-off-by: Andrew Ruder <andy@aeruder.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/urls-remotes.txt')
-rw-r--r--Documentation/urls-remotes.txt55
1 files changed, 55 insertions, 0 deletions
diff --git a/Documentation/urls-remotes.txt b/Documentation/urls-remotes.txt
new file mode 100644
index 0000000..5dd1f83
--- /dev/null
+++ b/Documentation/urls-remotes.txt
@@ -0,0 +1,55 @@
+include::urls.txt[]
+
+REMOTES
+-------
+
+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>
+
+------------
+
+Then 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 `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 "<remote>"]
+ url = <url>
+ push = <refspec>
+ fetch = <refspec>
+
+------------
+
+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>
+------------