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 6f7f54889dc74e1493c801c6057bdcf031717569..fc4502ea33f6e8a785b6390e1b742dd8d8393872 100644 (file)
--- 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