From: Mitsumasa KONDO Date: Wed, 17 May 2023 06:27:24 +0000 (+0900) Subject: doc: fix under bar to hyphen in stripe-unit and stripe-count X-Git-Tag: v19.0.0~1211^2 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=a2224a1b93f83c7572e41ea9ae30a509cf68b4d7;p=ceph.git doc: fix under bar to hyphen in stripe-unit and stripe-count Signed-off-by: Mitsumasa KONDO --- diff --git a/doc/man/8/rbd.rst b/doc/man/8/rbd.rst index 59e346209753..819c58c392bf 100644 --- a/doc/man/8/rbd.rst +++ b/doc/man/8/rbd.rst @@ -463,7 +463,7 @@ Commands The first diff could be - for stdin, and merged diff could be - for stdout, which enables multiple diff files to be merged using something like 'rbd merge-diff first second - | rbd merge-diff - third result'. Note this command - currently only support the source incremental diff with stripe_count == 1 + currently only support the source incremental diff with stripe-count == 1 :command:`migration abort` *image-spec* Cancel image migration. This step may be run after successful or @@ -731,19 +731,19 @@ The striping is controlled by three parameters: The size of objects we stripe over is a power of two. It will be rounded up the nearest power of two. The default object size is 4 MB, smallest is 4K and maximum is 32M. -.. option:: stripe_unit +.. option:: stripe-unit - Each [*stripe_unit*] contiguous bytes are stored adjacently in the same object, before we move on + Each [*stripe-unit*] contiguous bytes are stored adjacently in the same object, before we move on to the next object. -.. option:: stripe_count +.. option:: stripe-count - After we write [*stripe_unit*] bytes to [*stripe_count*] objects, we loop back to the initial object + After we write [*stripe-unit*] bytes to [*stripe-count*] objects, we loop back to the initial object and write another stripe, until the object reaches its maximum size. At that point, - we move on to the next [*stripe_count*] objects. + we move on to the next [*stripe-count*] objects. -By default, [*stripe_unit*] is the same as the object size and [*stripe_count*] is 1. Specifying a different -[*stripe_unit*] and/or [*stripe_count*] is often referred to as using "fancy" striping and requires format 2. +By default, [*stripe-unit*] is the same as the object size and [*stripe-count*] is 1. Specifying a different +[*stripe-unit*] and/or [*stripe-count*] is often referred to as using "fancy" striping and requires format 2. Kernel rbd (krbd) options @@ -983,7 +983,7 @@ To create an image and a clone from it:: rbd snap protect mypool/parent@snap rbd clone mypool/parent@snap otherpool/child -To create an image with a smaller stripe_unit (to better distribute small writes in some workloads):: +To create an image with a smaller stripe-unit (to better distribute small writes in some workloads):: rbd create mypool/myimage --size 102400 --stripe-unit 65536B --stripe-count 16