From eb7af87bcfc67798b58a99422988b9c368d7d642 Mon Sep 17 00:00:00 2001 From: "Shawn O. Pearce" Date: Tue, 21 Apr 2009 08:02:04 -0700 Subject: [PATCH] Document the SSH ControlMaster behavior of repo sync Signed-off-by: Shawn O. Pearce --- subcmds/sync.py | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/subcmds/sync.py b/subcmds/sync.py index b5cc604e..c61c3bb4 100644 --- a/subcmds/sync.py +++ b/subcmds/sync.py @@ -53,6 +53,35 @@ The -d/--detach option can be used to switch specified projects back to the manifest revision. This option is especially helpful if the project is currently on a topic branch, but the manifest revision is temporarily needed. + +SSH Connections +--------------- + +If at least one project remote URL uses an SSH connection (ssh://, +git+ssh://, or user@host:path syntax) repo will automatically +enable the SSH ControlMaster option when connecting to that host. +This feature permits other projects in the same '%prog' session to +reuse the same SSH tunnel, saving connection setup overheads. + +To disable this behavior on UNIX platforms, set the GIT_SSH +environment variable to 'ssh'. For example: + + export GIT_SSH=ssh + %prog + +Compatibility +~~~~~~~~~~~~~ + +This feature is automatically disabled on Windows, due to the lack +of UNIX domain socket support. + +This feature is not compatible with url.insteadof rewrites in the +user's ~/.gitconfig. '%prog' is currently not able to perform the +rewrite early enough to establish the ControlMaster tunnel. + +If the remote SSH daemon is Gerrit Code Review, version 2.0.10 or +later is required to fix a server side protocol bug. + """ def _Options(self, p):