remote: document the 'rm' subcommand

Signed-off-by: James Bowes <jbowes@dangerouslyinc.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt
index 94b9f177724993b800e5d0bd4e67f986bfffc188..027ba11bdb67ba540b63ec12e5a6b920cd2e5f7e 100644 (file)
--- a/Documentation/git-remote.txt
+++ b/Documentation/git-remote.txt
@@ -11,6 +11,7 @@ SYNOPSIS
 [verse]
 'git-remote'
 'git-remote' add [-t <branch>] [-m <branch>] [-f] [--mirror] <name> <url>
 [verse]
 'git-remote'
 'git-remote' add [-t <branch>] [-m <branch>] [-f] [--mirror] <name> <url>

+'git-remote' rm <name>

 'git-remote' show <name>
 'git-remote' prune <name>
 'git-remote' update [group]
 'git-remote' show <name>
 'git-remote' prune <name>
 'git-remote' update [group]


@@ -50,6 +51,11 @@ In mirror mode, enabled with `--mirror`, the refs will not be stored
 in the 'refs/remotes/' namespace, but in 'refs/heads/'.  This option
 only makes sense in bare repositories.
 
 in the 'refs/remotes/' namespace, but in 'refs/heads/'.  This option
 only makes sense in bare repositories.
 

+'rm'::
+
+Remove the remote named <name>. All remote tracking branches and
+configuration settings for the remote are removed.
+

 'show'::
 
 Gives some information about the remote <name>.
 'show'::
 
 Gives some information about the remote <name>.