From f53f2f14dd2e3ec81b635fbc438557f09f5617d7 Mon Sep 17 00:00:00 2001 From: Jeff Ohrstrom Date: Tue, 5 May 2020 15:03:19 -0400 Subject: [PATCH] reword ssh_cmd comment --- lib/ood_core/job/adapters/linux_host/launcher.rb | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/lib/ood_core/job/adapters/linux_host/launcher.rb b/lib/ood_core/job/adapters/linux_host/launcher.rb index d5e688142..8b8117028 100644 --- a/lib/ood_core/job/adapters/linux_host/launcher.rb +++ b/lib/ood_core/job/adapters/linux_host/launcher.rb @@ -116,12 +116,16 @@ def call(cmd, *args, env: {}, stdin: "") s.success? ? o : raise(Error, e) end - # The SSH invocation to send the command you pass into cmd (Array) + # The full command to ssh into the destination host and execute the command. + # SSH options include: # -t Force pseudo-terminal allocation (required to allow tmux to run) # -o BatchMode=yes (set mode to be non-interactive) # if ! strict_host_checking # -o UserKnownHostsFile=/dev/null (do not update the user's known hosts file) # -o StrictHostKeyChecking=no (do no check the user's known hosts file) + # + # @param destination_host [#to_s] the destination host you wish to ssh into + # @param cmd [Array<#to_s>] the command to be executed on the destination host def ssh_cmd(destination_host, cmd) if strict_host_checking [