From 330aae6bbe14d97917b66994484cabd0307d1873 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Fri, 6 Jul 2007 17:01:58 +0000 Subject: [PATCH] Autogenerated HTML docs for v1.5.3-rc0-39-g46f7 --- git-clone.html | 93 ++++++++++++++++++++++++++++++++++++++++-- git-clone.txt | 7 +++- git-fetch.html | 2 +- git-fetch.txt | 2 +- git-filter-branch.html | 5 ++- git-filter-branch.txt | 3 +- git-pull.html | 2 +- git-pull.txt | 2 +- git-push.html | 2 +- git-push.txt | 2 +- tutorial.html | 4 +- tutorial.txt | 2 +- urls-remotes.txt | 55 +++++++++++++++++++++++++ urls.txt | 54 ------------------------ 14 files changed, 164 insertions(+), 71 deletions(-) create mode 100644 urls-remotes.txt diff --git a/git-clone.html b/git-clone.html index 93dece946..4c1dcde1d 100644 --- a/git-clone.html +++ b/git-clone.html @@ -431,8 +431,9 @@ configuration variables.

- 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 section below for more information on specifying + repositories.

@@ -449,6 +450,92 @@ configuration variables.

+

GIT 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/ +

    +
    • +
  • +

    +https://host.xz/path/to/repo.git/ +

    +
    • +
  • +

    +git://host.xz/path/to/repo.git/ +

    +
    • +
  • +

    +git://host.xz/~user/path/to/repo.git/ +

    +
    • +
  • +

    +ssh://[user@]host.xz/path/to/repo.git/ +

    +
    • +
  • +

    +ssh://[user@]host.xz/~user/path/to/repo.git/ +

    +
    • +
  • +

    +ssh://[user@]host.xz/~/path/to/repo.git +

    +
    • +
+
+

SSH is the default transport protocol. You can optionally specify +which user to log-in as, and an alternate, scp-like syntax is also +supported. Both syntaxes support username expansion, +as does the native git protocol. The following three are +identical to the last three above, respectively:

+
+
+
    +
  • +

    +[user@]host.xz:/path/to/repo.git/ +

    +
    • +
  • +

    +[user@]host.xz:~user/path/to/repo.git/ +

    +
    • +
  • +

    +[user@]host.xz:path/to/repo.git +

    +
    • +
+
+

To sync with a local directory, use:

+
+
+
    +
  • +

    +/path/to/repo.git/ +

    +
    • +
+
+

Examples

@@ -521,7 +608,7 @@ Create a repository on the kernel.org machine that borrows from Linus
diff --git a/git-clone.txt b/git-clone.txt index 4a5bab510..2f39864b8 100644 --- a/git-clone.txt +++ b/git-clone.txt @@ -106,8 +106,9 @@ OPTIONS as patches. :: - The (possibly remote) repository to clone from. It can - be any URL git-fetch supports. + The (possibly remote) repository to clone from. See the + <> section below for more information on specifying + repositories. :: 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/git-fetch.html b/git-fetch.html index 8ad878675..ec657219e 100644 --- a/git-fetch.html +++ b/git-fetch.html @@ -651,7 +651,7 @@ Junio C Hamano <junkio@cox.net>

diff --git a/git-fetch.txt b/git-fetch.txt index 5fbeab76b..900347359 100644 --- a/git-fetch.txt +++ b/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/git-filter-branch.html b/git-filter-branch.html index 97f146bdf..555bb3ed2 100644 --- a/git-filter-branch.html +++ b/git-filter-branch.html @@ -307,7 +307,8 @@ be a good idea to redirect the temporary directory off-disk, e.g. on tmpfs. Reportedly the speedup is very noticeable.

Filters

The filters are applied in the order as listed below. The <command> -argument is always evaluated in shell using the eval command. +argument is always evaluated in shell using the eval command (with the +notable exception of the commit filter, for technical reasons). Prior to that, the $GIT_COMMIT environment variable will be set to contain the id of the commit being rewritten. Also, GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, GIT_AUTHOR_DATE, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL, @@ -561,7 +562,7 @@ and the git list <git@vger.kernel.org>

diff --git a/git-filter-branch.txt b/git-filter-branch.txt index 219a81db0..eaea82d0a 100644 --- a/git-filter-branch.txt +++ b/git-filter-branch.txt @@ -50,7 +50,8 @@ Filters ~~~~~~~ The filters are applied in the order as listed below. The -argument is always evaluated in shell using the 'eval' command. +argument is always evaluated in shell using the 'eval' command (with the +notable exception of the commit filter, for technical reasons). Prior to that, the $GIT_COMMIT environment variable will be set to contain the id of the commit being rewritten. Also, GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, GIT_AUTHOR_DATE, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL, diff --git a/git-pull.html b/git-pull.html index 374eb3e8b..f4a571503 100644 --- a/git-pull.html +++ b/git-pull.html @@ -896,7 +896,7 @@ Junio C Hamano and the git-list <git@vger.kernel.org>.

diff --git a/git-pull.txt b/git-pull.txt index 84693f8b1..e1eb2c1d0 100644 --- a/git-pull.txt +++ b/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/git-push.html b/git-push.html index 52d860e2d..8446225c2 100644 --- a/git-push.html +++ b/git-push.html @@ -589,7 +589,7 @@ by Linus Torvalds <torvalds@osdl.org>

diff --git a/git-push.txt b/git-push.txt index 665f6dc70..74a0da1ed 100644 --- a/git-push.txt +++ b/git-push.txt @@ -95,7 +95,7 @@ the remote repository. -v:: Run verbosely. -include::urls.txt[] +include::urls-remotes.txt[] Examples diff --git a/tutorial.html b/tutorial.html index 3fdd03827..4528590f9 100644 --- a/tutorial.html +++ b/tutorial.html @@ -563,7 +563,7 @@ used for pulls:

$ git config --get remote.origin.url
-/home/bob/myrepo
+/home/alice/project

(The complete configuration created by git-clone is visible using "git config -l", and the git-config(1) man page @@ -786,7 +786,7 @@ digressions that may be interesting at this point are:

diff --git a/tutorial.txt b/tutorial.txt index 118ff7286..53403c6db 100644 --- a/tutorial.txt +++ b/tutorial.txt @@ -354,7 +354,7 @@ used for pulls: ------------------------------------- $ git config --get remote.origin.url -/home/bob/myrepo +/home/alice/project ------------------------------------- (The complete configuration created by git-clone is visible using diff --git a/urls-remotes.txt b/urls-remotes.txt new file mode 100644 index 000000000..5dd1f836c --- /dev/null +++ b/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: + Pull: + +------------ + +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 `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 ""] + url = + push = + fetch = + +------------ + +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/` 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/: +------------ diff --git a/urls.txt b/urls.txt index 745f9677d..781df4174 100644 --- a/urls.txt +++ b/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: - Pull: - ------------- - -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 `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 ""] - url = - push = - fetch = - ------------- - -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/` 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/: ------------- -- 2.26.2