From: Zac Dover <zac.dover@gmail.com>
Date: Fri, 9 Dec 2022 00:21:47 +0000 (+1000)
Subject: doc/rbd: refine "Listing Block Device Images"
X-Git-Tag: v17.2.6~295^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F49348%2Fhead;p=ceph.git

doc/rbd: refine "Listing Block Device Images"

Refine the text and prompts in "Listing Block Device Images" 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 ad3c93535fbb614d593f74806fdfccdd60a1696f)
---

diff --git a/doc/rbd/rados-rbd-cmds.rst b/doc/rbd/rados-rbd-cmds.rst
index 70def1089625..9b5ce313baa1 100644
--- a/doc/rbd/rados-rbd-cmds.rst
+++ b/doc/rbd/rados-rbd-cmds.rst
@@ -87,33 +87,47 @@ the default pool ``rbd``, execute the following::
 Listing Block Device Images
 ===========================
 
-To list block devices in the ``rbd`` pool, execute the following
-(i.e., ``rbd`` is the default pool name):: 
+To list block devices in the ``rbd`` pool, run the following command:
 
-	rbd ls
+.. prompt:: bash $
+
+   rbd ls
+
+.. note:: ``rbd`` is the default pool name, and ``rbd ls`` lists the commands
+   in the default pool.
+
+To list block devices in a particular pool, run the following command, but
+replace ``{poolname}`` with the name of the pool: 
 
-To list block devices in a particular pool, execute the following,
-but replace ``{poolname}`` with the name of the pool:: 
+.. prompt:: bash $
 
-	rbd ls {poolname}
+   rbd ls {poolname}
 	
-For example::
+For example:
+
+.. prompt:: bash $
 
-	rbd ls swimmingpool
+   rbd ls swimmingpool
 
-To list deferred delete block devices in the ``rbd`` pool, execute the 
-following:: 
+To list "deferred delete" block devices in the ``rbd`` pool, run the
+following command:
 
-        rbd trash ls
+.. prompt:: bash $
 
-To list deferred delete block devices in a particular pool, execute the 
-following, but replace ``{poolname}`` with the name of the pool:: 
+   rbd trash ls
 
-        rbd trash ls {poolname}
+To list "deferred delete" block devices in a particular pool, run the 
+following command, but replace ``{poolname}`` with the name of the pool:
 
-For example::
+.. prompt:: bash $
+
+   rbd trash ls {poolname}
+
+For example:
+
+.. prompt:: bash $
 
-        rbd trash ls swimmingpool
+   rbd trash ls swimmingpool
 
 Retrieving Image Information
 ============================