diff options
author | Zac Dover <zac.dover@gmail.com> | 2022-12-09 01:21:47 +0100 |
---|---|---|
committer | Zac Dover <zac.dover@gmail.com> | 2022-12-09 01:21:47 +0100 |
commit | ad3c93535fbb614d593f74806fdfccdd60a1696f (patch) | |
tree | 6f24bea12b4f07534517c43a4ddf9d27954f4dec /doc/rbd | |
parent | Merge pull request #48375 from lbausch/mgr/balancer-fix_end_weekday_being_exc... (diff) | |
download | ceph-ad3c93535fbb614d593f74806fdfccdd60a1696f.tar.xz ceph-ad3c93535fbb614d593f74806fdfccdd60a1696f.zip |
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>
Diffstat (limited to 'doc/rbd')
-rw-r--r-- | doc/rbd/rados-rbd-cmds.rst | 46 |
1 files changed, 30 insertions, 16 deletions
diff --git a/doc/rbd/rados-rbd-cmds.rst b/doc/rbd/rados-rbd-cmds.rst index 70def108962..9b5ce313baa 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 ============================ |