Merge branch 'jk/maint-commit-v-strip'

[git.git] / Documentation / git-remote.txt

diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt
index 32db0aed11bee4fd97785fcd963dc3f5461f5657..fad983e297514da7e847196b0375e3254fdf235d 100644 (file)
--- a/Documentation/git-remote.txt
+++ b/Documentation/git-remote.txt
@@ -10,11 +10,12 @@ SYNOPSIS
 --------
 [verse]
 'git remote' [-v | --verbose]
-'git remote' add [-t <branch>] [-m <master>] [-f] [--mirror] <name> <url>
-'git remote' rm <name>
-'git remote' show [-n] <name>
-'git remote' prune [-n | --dry-run] <name>
-'git remote' update [group]
+'git remote add' [-t <branch>] [-m <master>] [-f] [--mirror] <name> <url>
+'git remote rename' <old> <new>
+'git remote rm' <name>
+'git remote show' [-n] <name>
+'git remote prune' [-n | --dry-run] <name>
+'git remote update' [group]
 
 DESCRIPTION
 -----------
@@ -61,6 +62,15 @@ only makes sense in bare repositories.  If a remote uses mirror
 mode, furthermore, `git push` will always behave as if `\--mirror`
 was passed.
 
+'rename'::
+
+Rename the remote named <old> to <new>. All remote tracking branches and
+configuration settings for the remote are updated.
++
+In case <old> and <new> are the same, and <old> is a file under
+`$GIT_DIR/remotes` or `$GIT_DIR/branches`, the remote is converted to
+the configuration file format.
+
 'rm'::
 
 Remove the remote named <name>. All remote tracking branches and
@@ -124,7 +134,7 @@ $ git checkout -b nfs linux-nfs/master
 ...
 ------------
 
-* Imitate 'git clone' but track only selected branches
+* Imitate 'git-clone' but track only selected branches
 +
 ------------
 $ mkdir project.git