From: Nathan Cutler <ncutler@suse.com>
Date: Fri, 14 Sep 2018 10:41:48 +0000 (+0200)
Subject: teuthology/task: improve documentation of "print" internal task
X-Git-Tag: 1.1.0~310^2
X-Git-Url: http://git.apps.os.sepia.ceph.com/?a=commitdiff_plain;h=7c30c49dc7dd9bc1bdcdea58a4465ad12d17747d;p=teuthology.git

teuthology/task: improve documentation of "print" internal task

The documentation is base on the commit message that first
introduced this task, but makes it clear that the arguments
will appear in teuthology.log.

Signed-off-by: Nathan Cutler <ncutler@suse.com>
---

diff --git a/teuthology/task/print.py b/teuthology/task/print.py
index 198203fe7f..6594c16819 100644
--- a/teuthology/task/print.py
+++ b/teuthology/task/print.py
@@ -1,5 +1,17 @@
 """
 Print task
+
+A task that logs whatever is given to it as an argument. Can be used
+like any other task (under sequential, etc...).j
+
+For example, the following would cause the strings "String" and "Another
+string" to appear in the teuthology.log before and after the chef task
+runs, respectively.
+
+tasks:
+- print: "String"
+- chef: null
+- print: "Another String"
 """
 
 import logging