]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/rados: refine English in crush-map-edits.rst 48362/head
authorZac Dover <zac.dover@gmail.com>
Wed, 14 Sep 2022 05:19:44 +0000 (15:19 +1000)
committerZac Dover <zac.dover@gmail.com>
Wed, 5 Oct 2022 05:25:21 +0000 (15:25 +1000)
This commit makes several refinements to the English in
rados/operations/crush-map-edits.rst, which refinements were suggested
by Cole Mitchell and Anthony D'Atri in the discussion of PR#48085.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
doc/rados/operations/crush-map-edits.rst

index ce84406bba1a44673cf7af6c6c896593fa5a3174..e0f472c23544e0dc4327172dc05412f2df4855dc 100644 (file)
@@ -169,7 +169,7 @@ media.
 To add a bucket type to the CRUSH map, create a new line under your list of
 bucket types. Enter ``type`` followed by a unique numeric ID and a bucket name.
 By convention, there is one leaf bucket and it is ``type 0``;  however, you may
-give it any name you like (e.g., osd, disk, drive, storage, etc.)::
+give it any name you like (e.g., osd, disk, drive, storage)::
 
        # types
        type {num} {bucket-name}
@@ -641,7 +641,7 @@ There are three types of transformations possible:
    single bucket.  For example, in the previous example, we want the
    ``ssd`` bucket to be mapped to the ``default`` bucket.
 
-The final command to convert the map comprised of the above fragments would be something like:
+The final command to convert the map comprising the above fragments would be something like:
 
 .. prompt:: bash $
 
@@ -653,7 +653,7 @@ The final command to convert the map comprised of the above fragments would be s
     --reclassify-bucket ssd ssd default \
     -o adjusted
 
-In order to ensure that the conversion is correct, there is a ``--compare`` command that will test a large sample of inputs to the CRUSH map and ensure that the same result comes back out.  These inputs are controlled by the same options that apply to the ``--test`` command.  For the above example,:
+In order to ensure that the conversion is correct, there is a ``--compare`` command that will test a large sample of inputs against the CRUSH map and check that the same result is output. These inputs are controlled by the same options that apply to the ``--test`` command.  For the above example,:
 
 .. prompt:: bash $
 
@@ -665,10 +665,10 @@ In order to ensure that the conversion is correct, there is a ``--compare`` comm
   rule 1 had 0/10240 mismatched mappings (0)
   maps appear equivalent
 
-If there were difference, you'd see what ratio of inputs are remapped
-in the parentheses.
+If there were differences, the ratio of remapped inputs would be reported in
+the parentheses.
 
-If you are satisfied with the adjusted map, you can apply it to the cluster with something like:
+When you are satisfied with the adjusted map, apply it to the cluster with a command of the form:
 
 .. prompt:: bash $