doc/rbd: refine "Creating a Block Device Image"#49338
Conversation
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>
anthonyeleven
left a comment
There was a problem hiding this comment.
one suggestion, non-blocking
|
|
||
| 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 |
There was a problem hiding this comment.
The "ran" is just past subjunctive. I suppose I could write it "if you were to run this command" or "were you to run this command", but those seem prolix to me.
I toyed with "is" in the place of "will be", which would have made the sentence "If you don't specify a pool when you create an image, then the image is stored in the default pool 'rbd'.". The clause "will be stored in the default pool" was chosen because the sentence's main clause is about the creation of an image, an act that occurs before the storage of that image. However, upon the review that your question has occasioned, I might well return to recast this sentence in the present tense.
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
Contribution Guidelines
To sign and title your commits, please refer to Submitting Patches to Ceph.
If you are submitting a fix for a stable branch (e.g. "pacific"), please refer to Submitting Patches to Ceph - Backports for the proper workflow.
Checklist
Show available Jenkins commands
jenkins retest this pleasejenkins test classic perfjenkins test crimson perfjenkins test signedjenkins test make checkjenkins test make check arm64jenkins test submodulesjenkins test dashboardjenkins test dashboard cephadmjenkins test apijenkins test docsjenkins render docsjenkins test ceph-volume alljenkins test ceph-volume toxjenkins test windows