undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add urls.txt to git-clone man page

Browse Source 
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 2007-07-04 17:21:36 -05:00 committed by Junio C Hamano
parent 114fd812f7
commit 37ba05619c
6 changed files with 63 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Documentation/git-clone.txt
View File

@ -106,8 +106,9 @@ OPTIONS
as patches. as patches.
<repository>:: <repository>::
The (possibly remote) repository to clone from. It can The (possibly remote) repository to clone from. See the
be any URL git-fetch supports. <<URLS,URLS>> section below for more information on specifying
repositories.
<directory>:: <directory>::
The name of a new directory to clone into. The "humanish" 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 for "host.xz:foo/.git"). Cloning into an existing directory
is not allowed. is not allowed.
include::urls.txt[]
Examples Examples
-------- --------

2
Documentation/git-fetch.txt
View File

@ -35,7 +35,7 @@ include::fetch-options.txt[]
include::pull-fetch-param.txt[] include::pull-fetch-param.txt[]
include::urls.txt[] include::urls-remotes.txt[]
SEE ALSO SEE ALSO
-------- --------

2
Documentation/git-pull.txt
View File

@ -29,7 +29,7 @@ include::fetch-options.txt[]
include::pull-fetch-param.txt[] include::pull-fetch-param.txt[]
include::urls.txt[] include::urls-remotes.txt[]
include::merge-strategies.txt[] include::merge-strategies.txt[]

2
Documentation/git-push.txt
View File

@ -95,7 +95,7 @@ the remote repository.
-v:: -v::
Run verbosely. Run verbosely.
include::urls.txt[] include::urls-remotes.txt[]
Examples Examples

55
Documentation/urls-remotes.txt Normal file
View 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>
------------

54
Documentation/urls.txt
View File

@ -32,57 +32,3 @@ To sync with a local directory, use:
=============================================================== ===============================================================
- /path/to/repo.git/ - /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>
------------