From bf75f13286c12d9928a35ec88ad8ead69558d71c Mon Sep 17 00:00:00 2001
From: Iustin Pop <iustin@google.com>
Date: Sun, 14 Dec 2008 12:04:29 +0000
Subject: [PATCH] SshRunner: add docstring for _BuildSshOptions
Reviewed-by: amishchenko
---
lib/ssh.py | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/lib/ssh.py b/lib/ssh.py
index aabb4bb0e..01405877d 100644
--- a/lib/ssh.py
+++ b/lib/ssh.py
@@ -75,6 +75,19 @@ class SshRunner:
def _BuildSshOptions(self, batch, ask_key, use_cluster_key,
strict_host_check):
+ """Builds a list with needed SSH options.
+
+ @param batch: same as ssh's batch option
+ @param ask_key: allows ssh to ask for key confirmation; this
+ parameter conflicts with the batch one
+ @param use_cluster_key: if True, use the cluster name as the
+ HostKeyAlias name
+ @param strict_host_check: this makes the host key checking strict
+
+ @rtype: list
+ @return: the list of options ready to use in L{utils.RunCmd}
+
+ """
options = [
"-oEscapeChar=none",
"-oHashKnownHosts=no",
--
GitLab