Skip to content

Commit 9607b66

Browse files
doc/cephfs: edit "Layout Fields" text
Improve the English in the "Layout Fields" section of doc/cephfs/file-layouts.rst. Co-authored-by: Anthony D'Atri <[email protected]> Signed-off-by: Zac Dover <[email protected]>
1 parent aa364ba commit 9607b66

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

doc/cephfs/file-layouts.rst

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,26 +20,38 @@ Layout fields
2020
-------------
2121

2222
pool
23-
String, giving ID or name. String can only have characters in the set [a-zA-Z0-9\_-.]. Which RADOS pool a file's data objects will be stored in.
23+
This is a string and returns either an ID or a name. Strings may contain
24+
only characters in the set ``[a-zA-Z0-9\_-.]``. This determines the RADOS
25+
pool that stores a file's data objects.
2426

2527
pool_id
26-
String of digits. This is the system assigned pool id for the RADOS pool whenever it is created.
28+
This is a string of digits. This is the pool ID that was assigned by Ceph
29+
at the time of the creation of the RADOS pool.
2730

2831
pool_name
29-
String, given name. This is the user defined name for the RADOS pool whenever user creates it.
32+
This is a string. This is the name of the RADOS pool as defined by the user
33+
when the pool was created.
3034

3135
pool_namespace
32-
String with only characters in the set [a-zA-Z0-9\_-.]. Within the data pool, which RADOS namespace the objects will
33-
be written to. Empty by default (i.e. default namespace).
36+
This is a string containing only characters in the set ``[a-zA-Z0-9\_-.]``.
37+
This determines which RADOS namespace within the data pool that the objects
38+
will be written to.
39+
Empty by default (i.e. default namespace).
3440

3541
stripe_unit
36-
Integer in bytes. The size (in bytes) of a block of data used in the RAID 0 distribution of a file. All stripe units for a file have equal size. The last stripe unit is typically incomplete–i.e. it represents the data at the end of the file as well as unused “space” beyond it up to the end of the fixed stripe unit size.
42+
This is an integer. The size (in bytes) of a block of data used in the
43+
distribution of a file. All stripe units for a file have equal size. The
44+
last stripe unit is typically incomplete–that is, it represents the data at
45+
the end of the file as well as unused “space” beyond the end of the file to
46+
the end of the fixed stripe unit size.
3747

3848
stripe_count
39-
Integer. The number of consecutive stripe units that constitute a RAID 0 “stripe” of file data.
49+
Integer. The number of consecutive stripe units that constitute a RAID 0
50+
“stripe” of file data.
4051

4152
object_size
42-
Integer in bytes. File data is chunked into RADOS objects of this size.
53+
Integer. The size of the object in bytes. File data is chunked into RADOS
54+
objects of this size.
4355

4456
.. tip::
4557

0 commit comments

Comments
 (0)