From: Dan Mick <dan.mick@redhat.com>
Date: Wed, 3 Dec 2014 03:06:33 +0000 (-0800)
Subject: orchestra/run.py: document use of Raw()
X-Git-Tag: 1.1.0~1061^2~15^2~3
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=3549421d6ee6987cc844118e6a947eda60710b9f;p=teuthology.git

orchestra/run.py: document use of Raw()

Signed-off-by: Dan Mick <dan.mick@redhat.com>
---

diff --git a/teuthology/orchestra/run.py b/teuthology/orchestra/run.py
index 6f7f54889..fc4502ea3 100644
--- a/teuthology/orchestra/run.py
+++ b/teuthology/orchestra/run.py
@@ -290,7 +290,10 @@ def run(
     name=None
 ):
     """
-    Run a command remotely.
+    Run a command remotely.  If any of 'args' contains shell metacharacters
+    that you want to pass unquoted, pass it as an instance of Raw(); otherwise
+    it will be quoted with pipes.quote() (single quote, and single quotes
+    enclosed in double quotes).
 
     :param client: SSHConnection to run the command with
     :param args: command to run