Additional information about the interative task in the README

Signed-off-by: Andrew Schoen <aschoen@redhat.com>

diff --git a/README.rst b/README.rst
index d25a7ede3a4f8318cb96738b2adbe0aa82f98c93..4b05529d9bd55a2a18047a68cc94737b307d8413 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -289,9 +289,22 @@ Interactive task facilities
 The ``interactive`` task presents a prompt for you to interact with the
 teuthology configuration.  The ``ctx`` variable is available to explore,
 and a ``pprint.PrettyPrinter().pprint`` object is added for convenience as
-'pp', so you can do things like pp(dict-of-interest) to see a formatted
+``pp``, so you can do things like pp(dict-of-interest) to see a formatted
 view of the dict.
 
+This is also useful to pause the execution of the test between two tasks,
+either to perform ad hoc operations, or to examine the state of the cluster.
+Hit ``control-D`` to continue when done.
+
+You need to nest ``interactive`` underneath of ``tasks`` in your config. You
+can have has many ``interactive`` tasks as needed in your task list.
+
+An example::
+
+    tasks:
+    - ceph:
+    - interactive:
+
 Test Sandbox Directory
 ======================