]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/cephfs: improve "layout fields" text 59250/head
authorZac Dover <zac.dover@proton.me>
Mon, 12 Aug 2024 12:38:14 +0000 (22:38 +1000)
committerZac Dover <zac.dover@proton.me>
Fri, 16 Aug 2024 18:44:22 +0000 (04:44 +1000)
Improve "layout fields" text in doc/cephfs/file-layouts.rst, as suggesed
by Anthony D'Atri in these comments:

https://github.com/ceph/ceph/pull/59021#discussion_r1704108581
https://github.com/ceph/ceph/pull/59021#discussion_r1704112320

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 0949b410433837f0509fb73169fa7f22c8f6c256)

doc/cephfs/file-layouts.rst

index c347524f4483438cbbf803bb063b6b55dd39c62a..3bb6ddeae9b9cb249eaf7ae04744a96c673c7a85 100644 (file)
@@ -20,7 +20,7 @@ Layout fields
 -------------
 
 pool
-    This is a string and returns either an ID or a name. Strings may contain
+    This is a string and contains either an ID or a name. Strings may contain
     only characters in the set ``[a-zA-Z0-9\_-.]``. This determines the RADOS
     pool that stores a file's data objects.
 
@@ -41,9 +41,9 @@ pool_namespace
 stripe_unit
     This is an integer. The size (in bytes) of a block of data used in the
     distribution of a file. All stripe units for a file have equal size. The
-    last stripe unit is typically incomplete–that is, it represents the data at
-    the end of the file as well as unused “space” beyond the end of the file to
-    the end of the fixed stripe unit size.
+    last stripe unit is typically only partly full of data: it holds file data
+    through EOF as well as padding that fills the balance of the fixed stripe
+    unit size. 
 
 stripe_count
     Integer. The number of consecutive stripe units that constitute a RAID 0