summaryrefslogtreecommitdiffstats
path: root/doc/rbd
diff options
context:
space:
mode:
authorZac Dover <zac.dover@gmail.com>2022-12-09 01:25:55 +0100
committerZac Dover <zac.dover@gmail.com>2022-12-09 01:45:19 +0100
commitd418037b3817b62cee4cb151ab84bb24c676b117 (patch)
tree9be589883df6fb94c39d7c326926c705f0a94b1e /doc/rbd
parentMerge pull request #48375 from lbausch/mgr/balancer-fix_end_weekday_being_exc... (diff)
downloadceph-d418037b3817b62cee4cb151ab84bb24c676b117.tar.xz
ceph-d418037b3817b62cee4cb151ab84bb24c676b117.zip
doc/rbd: refine "Retrieving Image Information"
Refine the text and prompts in "Retrieving Image Information" 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.rst37
1 files changed, 26 insertions, 11 deletions
diff --git a/doc/rbd/rados-rbd-cmds.rst b/doc/rbd/rados-rbd-cmds.rst
index 70def108962..f6fe622e28f 100644
--- a/doc/rbd/rados-rbd-cmds.rst
+++ b/doc/rbd/rados-rbd-cmds.rst
@@ -118,24 +118,39 @@ For example::
Retrieving Image Information
============================
-To retrieve information from a particular image, execute the following,
-but replace ``{image-name}`` with the name for the image::
+To retrieve information from a particular image, run the following command, but
+replace ``{image-name}`` with the name for the image:
- rbd info {image-name}
+.. prompt:: bash $
+
+ rbd info {image-name}
-For example::
+For example:
- rbd info foo
+.. prompt:: bash $
+
+ rbd info foo
-To retrieve information from an image within a pool, execute the following,
-but replace ``{image-name}`` with the name of the image and replace ``{pool-name}``
-with the name of the pool::
+To retrieve information from an image within a pool, run the following command,
+but replace ``{image-name}`` with the name of the image and replace
+``{pool-name}`` with the name of the pool:
- rbd info {pool-name}/{image-name}
+.. prompt:: bash $
-For example::
+ rbd info {pool-name}/{image-name}
+
+For example:
+
+.. prompt:: bash $
+
+ rbd info swimmingpool/bar
- rbd info swimmingpool/bar
+.. note:: Other naming conventions are possible, and might conflict with the
+ naming convention described here. For example, ``userid/<uuid>`` is a
+ possible name for an RBD image, and such a name might (at the least) be
+ confusing. In the intrest of helping the reader of this documentation to
+ form a clear idea of the way that RBD images are named, we offer this
+ syntax: ``rbd -p {pool-name} | info {image-name}``.
Resizing a Block Device Image
=============================