Docs: move git url and remotes text to separate sections
The sections on git urls and remotes files in the git-fetch, git-pull, and git-push manpages seem long enough to be worth a manpage section of their own. Signed-off-by: J. Bruce Fields <bfields@citi.umich.edu> Signed-off-by: Junio C Hamano <junkio@cox.net>
J. Bruce Fields committed
Feb 5, 2006 at 18:29 UTC
85a97d4e10c1ac4b87e856e2efe7bcd53d6868c3
5 files changed
+26
-19
Documentation/git-fetch.txt
+1
-1
@@ -27,7 +27,7 @@ include::fetch-options.txt[]
27
28
include::pull-fetch-param.txt[]
29
30
-
30
+include::urls.txt[]
31
32
SEE ALSO
33
--------
Documentation/git-pull.txt
+2
-1
@@ -29,8 +29,9 @@ include::fetch-options.txt[]
29
30
include::pull-fetch-param.txt[]
31
32
-include::merge-strategies.txt[]
32
+include::urls.txt[]
33
34
+include::merge-strategies.txt[]
35
36
EXAMPLES
37
--------
Documentation/git-push.txt
+3
-2
@@ -24,8 +24,8 @@ documentation for gitlink:git-receive-pack[1].
24
OPTIONS
25
-------
26
<repository>::
27
- The "remote" repository that is destination of a push operation.
28
-include::urls.txt[]
27
+ The "remote" repository that is destination of a push
28
+ operation. See the section <<URLS,GIT URLS>> below.
29
30
<refspec>::
31
The canonical format of a <refspec> parameter is
@@ -65,6 +65,7 @@ Some short-cut notations are also supported.
65
This flag disables the check. This can cause the
66
remote repository to lose commits; use it with care.
67
68
+include::urls.txt[]
69
70
Author
71
------
Documentation/pull-fetch-param.txt
+1
-2
@@ -1,7 +1,6 @@
1
<repository>::
2
The "remote" repository that is the source of a fetch
3
- or pull operation.
4
-include::urls.txt[]
3
+ or pull operation. See the section <<URLS,GIT URLS>> below.
4
5
<refspec>::
6
The canonical format of a <refspec> parameter is
Documentation/urls.txt
+19
-13
@@ -1,6 +1,9 @@
1
+GIT URLS[[URLS]]
2
+----------------
3
+
4
One of the following notations can be used
5
to name the remote repository:
3
-+
6
+
7
===============================================================
8
- rsync://host.xz/path/to/repo.git/
9
- http://host.xz/path/to/repo.git/
@@ -11,39 +14,42 @@ to name the remote repository:
14
- ssh://host.xz/~user/path/to/repo.git/
15
- ssh://host.xz/~/path/to/repo.git
16
===============================================================
14
-+
17
+
18
SSH Is the default transport protocol and also supports an
19
scp-like syntax. Both syntaxes support username expansion,
20
as does the native git protocol. The following three are
21
identical to the last three above, respectively:
19
-+
22
+
23
===============================================================
24
- host.xz:/path/to/repo.git/
25
- host.xz:~user/path/to/repo.git/
26
- host.xz:path/to/repo.git
27
===============================================================
25
-+
28
+
29
To sync with a local directory, use:
27
-+
30
+
31
===============================================================
32
- /path/to/repo.git/
33
===============================================================
31
-+
34
+
35
+REMOTES
36
+-------
37
+
38
In addition to the above, as a short-hand, the name of a
39
file in `$GIT_DIR/remotes` directory can be given; the
40
named file should be in the following format:
35
-+
41
+
42
URL: one of the above URL format
43
Push: <refspec>
44
Pull: <refspec>
39
-+
40
-When such a short-hand is specified in place of
45
+
46
+Then such a short-hand is specified in place of
47
<repository> without <refspec> parameters on the command
48
line, <refspec> specified on `Push:` lines or `Pull:`
49
lines are used for `git-push` and `git-fetch`/`git-pull`,
50
respectively. Multiple `Push:` and and `Pull:` lines may
51
be specified for additional branch mappings.
46
-+
52
+
53
The name of a file in `$GIT_DIR/branches` directory can be
54
specified as an older notation short-hand; the named
55
file should contain a single line, a URL in one of the
@@ -52,11 +58,11 @@ name of remote head (URL fragment notation).
58
`$GIT_DIR/branches/<remote>` file that stores a <url>
59
without the fragment is equivalent to have this in the
60
corresponding file in the `$GIT_DIR/remotes/` directory.
55
-+
61
+
62
URL: <url>
63
Pull: refs/heads/master:<remote>
58
-+
64
+
65
while having `<url>#<head>` is equivalent to
60
-+
66
+
67
URL: <url>
68
Pull: refs/heads/<head>:<remote>