mirror of
https://github.com/git/git
synced 2024-10-02 14:45:21 +00:00
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>
This commit is contained in:
Andrew Ruder
Junio C Hamano
parent
114fd812f7
commit
37ba05619c
|
|
@ -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
|
||||
--------
|
||||
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ include::fetch-options.txt[]
|
|||
|
||||
include::pull-fetch-param.txt[]
|
||||
|
||||
include::urls.txt[]
|
||||
include::urls-remotes.txt[]
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ include::fetch-options.txt[]
|
|||
|
||||
include::pull-fetch-param.txt[]
|
||||
|
||||
include::urls.txt[]
|
||||
include::urls-remotes.txt[]
|
||||
|
||||
include::merge-strategies.txt[]
|
||||
|
||||
|
|
|
|||
|
|
@ -95,7 +95,7 @@ the remote repository.
|
|||
-v::
|
||||
Run verbosely.
|
||||
|
||||
include::urls.txt[]
|
||||
include::urls-remotes.txt[]
|
||||
|
||||
|
||||
Examples
|
||||
|
|
|
|||
55
Documentation/urls-remotes.txt
Normal file
55
Documentation/urls-remotes.txt
Normal file
|
|
@ -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>
|
||||
------------
|
||||
|
|
@ -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>
|
||||
------------
|
||||
|
|
|
|||
Loading…
Reference in a new issue