Skip to content

Commit b8b6af8

Browse files
authored
Merge pull request ceph#51547 from mitsu-ko/patch2
doc: fix underbar to hyphen in stripe-unit and stripe-count Reviewed-by: Ilya Dryomov <idryomov@gmail.com>
2 parents 574c938 + a2224a1 commit b8b6af8

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

doc/man/8/rbd.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -463,7 +463,7 @@ Commands
463463
The first diff could be - for stdin, and merged diff could be - for stdout, which
464464
enables multiple diff files to be merged using something like
465465
'rbd merge-diff first second - | rbd merge-diff - third result'. Note this command
466-
currently only support the source incremental diff with stripe_count == 1
466+
currently only support the source incremental diff with stripe-count == 1
467467

468468
:command:`migration abort` *image-spec*
469469
Cancel image migration. This step may be run after successful or
@@ -731,19 +731,19 @@ The striping is controlled by three parameters:
731731
The size of objects we stripe over is a power of two. It will be rounded up the nearest power of two.
732732
The default object size is 4 MB, smallest is 4K and maximum is 32M.
733733

734-
.. option:: stripe_unit
734+
.. option:: stripe-unit
735735

736-
Each [*stripe_unit*] contiguous bytes are stored adjacently in the same object, before we move on
736+
Each [*stripe-unit*] contiguous bytes are stored adjacently in the same object, before we move on
737737
to the next object.
738738

739-
.. option:: stripe_count
739+
.. option:: stripe-count
740740

741-
After we write [*stripe_unit*] bytes to [*stripe_count*] objects, we loop back to the initial object
741+
After we write [*stripe-unit*] bytes to [*stripe-count*] objects, we loop back to the initial object
742742
and write another stripe, until the object reaches its maximum size. At that point,
743-
we move on to the next [*stripe_count*] objects.
743+
we move on to the next [*stripe-count*] objects.
744744

745-
By default, [*stripe_unit*] is the same as the object size and [*stripe_count*] is 1. Specifying a different
746-
[*stripe_unit*] and/or [*stripe_count*] is often referred to as using "fancy" striping and requires format 2.
745+
By default, [*stripe-unit*] is the same as the object size and [*stripe-count*] is 1. Specifying a different
746+
[*stripe-unit*] and/or [*stripe-count*] is often referred to as using "fancy" striping and requires format 2.
747747

748748

749749
Kernel rbd (krbd) options
@@ -983,7 +983,7 @@ To create an image and a clone from it::
983983
rbd snap protect mypool/parent@snap
984984
rbd clone mypool/parent@snap otherpool/child
985985

986-
To create an image with a smaller stripe_unit (to better distribute small writes in some workloads)::
986+
To create an image with a smaller stripe-unit (to better distribute small writes in some workloads)::
987987

988988
rbd create mypool/myimage --size 102400 --stripe-unit 65536B --stripe-count 16
989989

0 commit comments

Comments
 (0)