diff options
| author |  Andrew Ruder <andy@aeruder.net> | 2007-07-04 17:21:36 -0500 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2007-07-05 21:43:48 -0700 |
| commit | 37ba05619c76f9dbde35c418c6fc8af7bcda24c8 (patch) | |
| tree | b6c3f07f6d9bf3be5dee0ff6d0c0a6bedfaa954a /Documentation | |
| parent | Fix git-stash(1) markup. (diff) | |
| download | tgif-37ba05619c76f9dbde35c418c6fc8af7bcda24c8.tar.xz | |
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')
| -rw-r--r-- | Documentation/git-clone.txt | 7 | ||||
| -rw-r--r-- | Documentation/git-fetch.txt | 2 | ||||
| -rw-r--r-- | Documentation/git-pull.txt | 2 | ||||
| -rw-r--r-- | Documentation/git-push.txt | 2 | ||||
| -rw-r--r-- | Documentation/urls-remotes.txt | 55 | ||||
| -rw-r--r-- | Documentation/urls.txt | 54 |
6 files changed, 63 insertions, 59 deletions
diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt index 4a5bab510e..2f39864b8e 100644 --- a/Documentation/git-clone.txt +++ b/Documentation/git-clone.txt @@ -106,8 +106,9 @@ OPTIONS as patches. <repository>:: - The (possibly remote) repository to clone from. It can - be any URL git-fetch supports. + The (possibly remote) repository to clone from. See the + <<URLS,URLS>> section below for more information on specifying + repositories. <directory>:: The name of a new directory to clone into. The "humanish" @@ -116,6 +117,8 @@ OPTIONS for "host.xz:foo/.git"). Cloning into an existing directory is not allowed. +include::urls.txt[] + Examples -------- diff --git a/Documentation/git-fetch.txt b/Documentation/git-fetch.txt index 5fbeab76b7..9003473596 100644 --- a/Documentation/git-fetch.txt +++ b/Documentation/git-fetch.txt @@ -35,7 +35,7 @@ include::fetch-options.txt[] include::pull-fetch-param.txt[] -include::urls.txt[] +include::urls-remotes.txt[] SEE ALSO -------- diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt index 84693f8b10..e1eb2c1d00 100644 --- a/Documentation/git-pull.txt +++ b/Documentation/git-pull.txt @@ -29,7 +29,7 @@ include::fetch-options.txt[] include::pull-fetch-param.txt[] -include::urls.txt[] +include::urls-remotes.txt[] include::merge-strategies.txt[] diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt index 665f6dc709..74a0da1ed4 100644 --- a/Documentation/git-push.txt +++ b/Documentation/git-push.txt @@ -95,7 +95,7 @@ the remote repository. -v:: Run verbosely. -include::urls.txt[] +include::urls-remotes.txt[] Examples diff --git a/Documentation/urls-remotes.txt b/Documentation/urls-remotes.txt new file mode 100644 index 0000000000..5dd1f836c6 --- /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> +------------ diff --git a/Documentation/urls.txt b/Documentation/urls.txt index 745f9677d0..781df4174b 100644 --- a/Documentation/urls.txt +++ b/Documentation/urls.txt @@ -32,57 +32,3 @@ 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: <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> ------------- |