From 85a97d4e10c1ac4b87e856e2efe7bcd53d6868c3 Mon Sep 17 00:00:00 2001 From: "J. Bruce Fields" Date: Sun, 5 Feb 2006 18:29:49 -0500 Subject: 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 Signed-off-by: Junio C Hamano diff --git a/Documentation/git-fetch.txt b/Documentation/git-fetch.txt index d1b45f9..a67dc34 100644 --- a/Documentation/git-fetch.txt +++ b/Documentation/git-fetch.txt @@ -27,7 +27,7 @@ include::fetch-options.txt[] include::pull-fetch-param.txt[] - +include::urls.txt[] SEE ALSO -------- diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt index 3a7d385..20175f4 100644 --- a/Documentation/git-pull.txt +++ b/Documentation/git-pull.txt @@ -29,8 +29,9 @@ include::fetch-options.txt[] include::pull-fetch-param.txt[] -include::merge-strategies.txt[] +include::urls.txt[] +include::merge-strategies.txt[] EXAMPLES -------- diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt index 7e9452e..ce909f5 100644 --- a/Documentation/git-push.txt +++ b/Documentation/git-push.txt @@ -24,8 +24,8 @@ documentation for gitlink:git-receive-pack[1]. OPTIONS ------- :: - The "remote" repository that is destination of a push operation. -include::urls.txt[] + The "remote" repository that is destination of a push + operation. See the section <> below. :: The canonical format of a parameter is @@ -65,6 +65,7 @@ Some short-cut notations are also supported. This flag disables the check. This can cause the remote repository to lose commits; use it with care. +include::urls.txt[] Author ------ diff --git a/Documentation/pull-fetch-param.txt b/Documentation/pull-fetch-param.txt index 9011ffb..e852f41 100644 --- a/Documentation/pull-fetch-param.txt +++ b/Documentation/pull-fetch-param.txt @@ -1,7 +1,6 @@ :: The "remote" repository that is the source of a fetch - or pull operation. -include::urls.txt[] + or pull operation. See the section <> below. :: The canonical format of a parameter is diff --git a/Documentation/urls.txt b/Documentation/urls.txt index e027c71..7477413 100644 --- a/Documentation/urls.txt +++ b/Documentation/urls.txt @@ -1,6 +1,9 @@ +GIT URLS[[URLS]] +---------------- + 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/ @@ -11,39 +14,42 @@ to name the remote repository: - 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/ =============================================================== -+ + +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: Pull: -+ -When such a short-hand is specified in place of + +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 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 @@ -52,11 +58,11 @@ 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/: -- cgit v0.10.2-6-g49f6