Correct the docs about GIT_SSH.

In particular, it can get called with four arguments if you happen to
be referring to a repo using the ssh:// scheme with a non-default port
number.

Signed-off-by: Dan Bornstein <danfuzz@milk.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/Documentation/git.txt b/Documentation/git.txt
index e0135150b1ec4e6ea71cc950e58e22fb031375bd..98a45addf54730d86bbca585e854fcc7ae011b79 100644 (file)
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -764,9 +764,12 @@ other
        If this environment variable is set then 'git fetch'
        and 'git push' will use this command instead
        of 'ssh' when they need to connect to a remote system.
        If this environment variable is set then 'git fetch'
        and 'git push' will use this command instead
        of 'ssh' when they need to connect to a remote system.

-       The '$GIT_SSH' command will be given exactly two arguments:
-       the 'username@host' (or just 'host') from the URL and the
-       shell command to execute on that remote system.
+       The '$GIT_SSH' command will be given exactly two or
+       four arguments: the 'username@host' (or just 'host')
+       from the URL and the shell command to execute on that
+       remote system, optionally preceded by '-p' (literally) and
+       the 'port' from the URL when it specifies something other
+       than the default SSH port.

 +
 To pass options to the program that you want to list in GIT_SSH
 you will need to wrap the program and options into a shell script,
 +
 To pass options to the program that you want to list in GIT_SSH
 you will need to wrap the program and options into a shell script,