From 0f3908758947b2279f5d2d4a294653d76a62d468 Mon Sep 17 00:00:00 2001 From: "Shawn O. Pearce" Date: Sat, 3 Feb 2007 23:02:59 -0500 Subject: [PATCH] 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 Signed-off-by: Junio C Hamano --- Documentation/git-remote.txt | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt index 817651eaa..a60c31a31 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 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 for the repository at . The command `git fetch ` can then be used to create and update remote-tracking branches /. -In the third form, gives some information about the remote . +'show':: -In the fourth form, deletes all stale tracking branches under . +Gives some information about the remote . + +'prune':: + +Deletes all stale tracking branches under . These stale branches have already been removed from the remote repository referenced by , but are still locally available in "remotes/". + +DISCUSSION +---------- + The remote configuration is achieved using the `remote.origin.url` and `remote.origin.fetch` configuration variables. (See gitlink:git-config[1]). -- 2.30.2