Skip to content

Commit 4c96870

Browse files
morbidrsadamien-lemoal
authored andcommitted
zonefs: update documentation to reflect zone size vs capacity
Update the zonefs documentation to reflect the difference between a zone's size and it's capacity. The maximum file size in zonefs is the zones capacity, for ZBC and ZAC based devices, which do not have a separate zone capacity, the zone capacity is equal to the zone size. Signed-off-by: Johannes Thumshirn <[email protected]> Reviewed-by: Christoph Hellwig <[email protected]> Signed-off-by: Damien Le Moal <[email protected]>
1 parent e3c3155 commit 4c96870

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

Documentation/filesystems/zonefs.rst

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -110,14 +110,14 @@ contain files named "0", "1", "2", ... The file numbers also represent
110110
increasing zone start sector on the device.
111111

112112
All read and write operations to zone files are not allowed beyond the file
113-
maximum size, that is, beyond the zone size. Any access exceeding the zone
114-
size is failed with the -EFBIG error.
113+
maximum size, that is, beyond the zone capacity. Any access exceeding the zone
114+
capacity is failed with the -EFBIG error.
115115

116116
Creating, deleting, renaming or modifying any attribute of files and
117117
sub-directories is not allowed.
118118

119119
The number of blocks of a file as reported by stat() and fstat() indicates the
120-
size of the file zone, or in other words, the maximum file size.
120+
capacity of the zone file, or in other words, the maximum file size.
121121

122122
Conventional zone files
123123
-----------------------
@@ -156,8 +156,8 @@ all accepted.
156156

157157
Truncating sequential zone files is allowed only down to 0, in which case, the
158158
zone is reset to rewind the file zone write pointer position to the start of
159-
the zone, or up to the zone size, in which case the file's zone is transitioned
160-
to the FULL state (finish zone operation).
159+
the zone, or up to the zone capacity, in which case the file's zone is
160+
transitioned to the FULL state (finish zone operation).
161161

162162
Format options
163163
--------------
@@ -324,7 +324,7 @@ file size set to 0. This is necessary as the write pointer of read-only zones
324324
is defined as invalib by the ZBC and ZAC standards, making it impossible to
325325
discover the amount of data that has been written to the zone. In the case of a
326326
read-only zone discovered at run-time, as indicated in the previous section.
327-
the size of the zone file is left unchanged from its last updated value.
327+
The size of the zone file is left unchanged from its last updated value.
328328

329329
Zonefs User Space Tools
330330
=======================
@@ -401,8 +401,9 @@ append-writes to the file::
401401
# ls -l /mnt/seq/0
402402
-rw-r----- 1 root root 0 Nov 25 13:49 /mnt/seq/0
403403

404-
Since files are statically mapped to zones on the disk, the number of blocks of
405-
a file as reported by stat() and fstat() indicates the size of the file zone::
404+
Since files are statically mapped to zones on the disk, the number of blocks
405+
of a file as reported by stat() and fstat() indicates the capacity of the file
406+
zone::
406407

407408
# stat /mnt/seq/0
408409
File: /mnt/seq/0
@@ -416,5 +417,6 @@ a file as reported by stat() and fstat() indicates the size of the file zone::
416417

417418
The number of blocks of the file ("Blocks") in units of 512B blocks gives the
418419
maximum file size of 524288 * 512 B = 256 MB, corresponding to the device zone
419-
size in this example. Of note is that the "IO block" field always indicates the
420-
minimum I/O size for writes and corresponds to the device physical sector size.
420+
capacity in this example. Of note is that the "IO block" field always
421+
indicates the minimum I/O size for writes and corresponds to the device
422+
physical sector size.

0 commit comments

Comments
 (0)