]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
rados: fix documentation format
authorJosh Durgin <josh.durgin@dreamhost.com>
Fri, 30 Dec 2011 20:50:59 +0000 (12:50 -0800)
committerJosh Durgin <josh.durgin@dreamhost.com>
Fri, 30 Dec 2011 22:37:45 +0000 (14:37 -0800)
teuthology/task/rados.py

index 916ba9b1839f88af646ccaa357da6c2b94bd9635..eebde3a1d08b120463ebfc53d93b34391373125d 100644 (file)
@@ -8,28 +8,28 @@ log = logging.getLogger(__name__)
 @contextlib.contextmanager
 def task(ctx, config):
     """
-    Run testrados
+    Run RadosModel-based integration tests.
 
-    The config should be as follows:
+    The config should be as follows::
 
-    testrados:
-        clients: [client list]
-        ops: <number of ops>
-        objects: <number of objects to use>
-        maxinflight: <max number of operations in flight>
-        snaps: <create/remove/rollback snaps>
+        testrados:
+          clients: [client list]
+          ops: <number of ops>
+          objects: <number of objects to use>
+          maxinflight: <max number of operations in flight>
+          snaps: <create/remove/rollback snaps>
 
-    example:
+    For example::
 
-    tasks:
-    - ceph:
-    - testrados:
-        clients: [client.0]
-        ops: 1000
-        objects: 25
-        maxinflight: 16
-        snaps: true
-    - interactive:
+        tasks:
+        - ceph:
+        - testrados:
+            clients: [client.0]
+            ops: 1000
+            objects: 25
+            maxinflight: 16
+            snaps: true
+        - interactive:
     """
     log.info('Beginning testrados...')
     assert isinstance(config, dict), \