summaryrefslogtreecommitdiff
path: root/Documentation/git-remote.txt
diff options
context:
space:
mode:
authorShawn O. Pearce <spearce@spearce.org>2007-02-04 04:02:59 (GMT)
committerJunio C Hamano <junkio@cox.net>2007-02-04 05:49:49 (GMT)
commit0f3908758947b2279f5d2d4a294653d76a62d468 (patch)
treebad503911f1bfec272501ad4cbc2f5fb4e2be7a2 /Documentation/git-remote.txt
parent9673a0b182fdb39e6a00e2cbdcfacee769201053 (diff)
downloadgit-0f3908758947b2279f5d2d4a294653d76a62d468.zip
git-0f3908758947b2279f5d2d4a294653d76a62d468.tar.gz
git-0f3908758947b2279f5d2d4a294653d76a62d468.tar.bz2
Cleanup subcommand documentation for git-remote.
Jakub Narebski pointed out the positional notation in git-remote's documentation was very confusing, especially now that we have 3 supported subcommands. Instead of referring to subcommands by position, refer to them by name. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation/git-remote.txt')
-rw-r--r--Documentation/git-remote.txt23
1 files changed, 19 insertions, 4 deletions
diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt
index 817651e..a60c31a 100644
--- a/Documentation/git-remote.txt
+++ b/Documentation/git-remote.txt
@@ -19,18 +19,33 @@ DESCRIPTION
Manage the set of repositories ("remotes") whose branches you track.
-With no arguments, shows a list of existing remotes.
-In the second form, adds a remote named <name> for the repository at
+COMMANDS
+--------
+
+With no arguments, shows a list of existing remotes. Several
+subcommands are available to perform operations on the remotes.
+
+'add'::
+
+Adds a remote named <name> for the repository at
<url>. The command `git fetch <name>` can then be used to create and
update remote-tracking branches <name>/<branch>.
-In the third form, gives some information about the remote <name>.
+'show'::
-In the fourth form, deletes all stale tracking branches under <name>.
+Gives some information about the remote <name>.
+
+'prune'::
+
+Deletes all stale tracking branches under <name>.
These stale branches have already been removed from the remote repository
referenced by <name>, but are still locally available in "remotes/<name>".
+
+DISCUSSION
+----------
+
The remote configuration is achieved using the `remote.origin.url` and
`remote.origin.fetch` configuration variables. (See
gitlink:git-config[1]).