]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/rbd: refine "Creating a Block Device Image" 49346/head
authorZac Dover <zac.dover@gmail.com>
Thu, 8 Dec 2022 23:53:14 +0000 (09:53 +1000)
committerZac Dover <zac.dover@gmail.com>
Fri, 9 Dec 2022 06:44:19 +0000 (16:44 +1000)
Refine the English and prompts in "Creating a Block Device Image" in
doc/rbd/rados-rbd-cmds.rst.

https://tracker.ceph.com/issues/57001

Signed-off-by: Zac Dover <zac.dover@gmail.com>
(cherry picked from commit 20b14437d6847fefdd3435bc9ec7a8b5580968f8)

doc/rbd/rados-rbd-cmds.rst

index 70def1089625e382c5ce33766f9bdbe379d60fd4..449011efc92238d66bdaf897be42b3f3de55be91 100644 (file)
@@ -65,24 +65,30 @@ Creating a Block Device Image
 =============================
 
 Before you can add a block device to a node, you must create an image for it in
-the :term:`Ceph Storage Cluster` first. To create a block device image, execute
-the  following::
+the :term:`Ceph Storage Cluster`. To create a block device image, run a command of this form: 
 
-       rbd create --size {megabytes} {pool-name}/{image-name}
+.. prompt:: bash $
+
+   rbd create --size {megabytes} {pool-name}/{image-name}
 
 For example, to create a 1GB image named ``bar`` that stores information in a
-pool named ``swimmingpool``, execute the following::
+pool named ``swimmingpool``, run this command:
+
+.. prompt:: bash $
+
+   rbd create --size 1024 swimmingpool/bar
 
-       rbd create --size 1024 swimmingpool/bar
+If you don't specify a pool when you create an image, then the image will be
+stored in the default pool ``rbd``. For example, if you ran this command, you
+wuold create a 1GB image named ``foo`` that is stored in the default pool
+``rbd``:
 
-If you don't specify pool when creating an image, it will be stored in the
-default pool ``rbd``. For example, to create a 1GB image named ``foo`` stored in
-the default pool ``rbd``, execute the following::
+.. prompt:: bash $
 
-       rbd create --size 1024 foo
+   rbd create --size 1024 foo
 
-.. note:: You must create a pool first before you can specify it as a 
-   source. See `Storage Pools`_ for details.
+.. note:: You must create a pool before you can specify it as a source. See
+   `Storage Pools`_ for details.
 
 Listing Block Device Images
 ===========================