hollalinux
/
linux-sg2042
mirror of https://github.com/sophgo/linux-riscv.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

f2fs: Documentation edits/fixes 

Correct grammar and spelling.

Drop duplicate section for resize.f2fs.

Change one occurrence of F2fs to F2FS for consistency.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jaegeuk Kim <jaegeuk@kernel.org>
Cc: Chao Yu <yuchao0@huawei.com>
Cc: linux-f2fs-devel@lists.sourceforge.net
Reviewed-by: Chao Yu <yuchao0@huawei.com>
Signed-off-by: Jaegeuk Kim <jaegeuk@kernel.org>
This commit is contained in:
Randy Dunlap 2020-09-02 17:08:31 -07:00 committed by Jaegeuk Kim
parent 0e2b7385cb
commit ca313c82d1
1 changed files with 23 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
Documentation/filesystems/f2fs.rst
View File

@ -127,14 +127,14 @@ active_logs=%u Support configuring the number of active logs. In the
current design, f2fs supports only 2, 4, and 6 logs. current design, f2fs supports only 2, 4, and 6 logs.
Default number is 6. Default number is 6.
disable_ext_identify Disable the extension list configured by mkfs, so f2fs disable_ext_identify Disable the extension list configured by mkfs, so f2fs
does not aware of cold files such as media files. is not aware of cold files such as media files.
inline_xattr Enable the inline xattrs feature. inline_xattr Enable the inline xattrs feature.
noinline_xattr Disable the inline xattrs feature. noinline_xattr Disable the inline xattrs feature.
inline_xattr_size=%u Support configuring inline xattr size, it depends on inline_xattr_size=%u Support configuring inline xattr size, it depends on
flexible inline xattr feature. flexible inline xattr feature.
inline_data Enable the inline data feature: New created small(<~3.4k) inline_data Enable the inline data feature: Newly created small (<~3.4k)
files can be written into inode block. files can be written into inode block.
inline_dentry Enable the inline dir feature: data in new created inline_dentry Enable the inline dir feature: data in newly created
directory entries can be written into inode block. The directory entries can be written into inode block. The
space of inode block which is used to store inline space of inode block which is used to store inline
dentries is limited to ~3.4k. dentries is limited to ~3.4k.
@ -203,9 +203,9 @@ usrjquota=<file> Appoint specified file and type during mount, so that quota
grpjquota=<file> information can be properly updated during recovery flow, grpjquota=<file> information can be properly updated during recovery flow,
prjjquota=<file> <quota file>: must be in root directory; prjjquota=<file> <quota file>: must be in root directory;
jqfmt=<quota type> <quota type>: [vfsold,vfsv0,vfsv1]. jqfmt=<quota type> <quota type>: [vfsold,vfsv0,vfsv1].
offusrjquota Turn off user journelled quota. offusrjquota Turn off user journalled quota.
offgrpjquota Turn off group journelled quota. offgrpjquota Turn off group journalled quota.
offprjjquota Turn off project journelled quota. offprjjquota Turn off project journalled quota.
quota Enable plain user disk quota accounting. quota Enable plain user disk quota accounting.
noquota Disable all plain disk quota option. noquota Disable all plain disk quota option.
whint_mode=%s Control which write hints are passed down to block whint_mode=%s Control which write hints are passed down to block
@ -303,7 +303,7 @@ Usage
# insmod f2fs.ko # insmod f2fs.ko
3. Create a directory trying to mount:: 3. Create a directory to use when mounting::
# mkdir /mnt/f2fs # mkdir /mnt/f2fs
@ -339,7 +339,7 @@ The quick options consist of:
1 is set by default, which conducts discard. 1 is set by default, which conducts discard.
=============== =========================================================== =============== ===========================================================
Note that, please refer manpage of mkfs.f2fs(8) to get full option list. Note: please refer to the manpage of mkfs.f2fs(8) to get full option list.
fsck.f2fs fsck.f2fs
--------- ---------
@ -352,7 +352,7 @@ The quick options consist of::
-d debug level [default:0] -d debug level [default:0]
Note that, please refer manpage of fsck.f2fs(8) to get full option list. Note: please refer to the manpage of fsck.f2fs(8) to get full option list.
dump.f2fs dump.f2fs
--------- ---------
@ -377,43 +377,36 @@ Examples::
# dump.f2fs -s 0~-1 /dev/sdx (SIT dump) # dump.f2fs -s 0~-1 /dev/sdx (SIT dump)
# dump.f2fs -a 0~-1 /dev/sdx (SSA dump) # dump.f2fs -a 0~-1 /dev/sdx (SSA dump)
Note that, please refer manpage of dump.f2fs(8) to get full option list. Note: please refer to the manpage of dump.f2fs(8) to get full option list.
sload.f2fs sload.f2fs
---------- ----------
The sload.f2fs gives a way to insert files and directories in the exisiting disk The sload.f2fs gives a way to insert files and directories in the exisiting disk
image. This tool is useful when building f2fs images given compiled files. image. This tool is useful when building f2fs images given compiled files.
Note that, please refer manpage of sload.f2fs(8) to get full option list. Note: please refer to the manpage of sload.f2fs(8) to get full option list.
resize.f2fs resize.f2fs
----------- -----------
The resize.f2fs can be used when user want to resize the f2fs-formatted disk The resize.f2fs lets a user resize the f2fs-formatted disk image, while preserving
image, while keeping the stored files and directories.
Note that, please refer manpage of resize.f2fs(8) to get full option list.
resize.f2fs
-----------
The resize.f2fs let user resize the f2fs-formatted disk image, while preserving
all the files and directories stored in the image. all the files and directories stored in the image.
Note that, please refer manpage of resize.f2fs(8) to get full option list. Note: please refer to the manpage of resize.f2fs(8) to get full option list.
defrag.f2fs defrag.f2fs
----------- -----------
The defrag.f2fs can be used to defragmente scattered writtend data as well as The defrag.f2fs can be used to defragment scattered written data as well as
filesystem metadata across the disk. This can improve the write speed by giving filesystem metadata across the disk. This can improve the write speed by giving
more free consecutive space. more free consecutive space.
Note that, please refer manpage of defrag.f2fs(8) to get full option list. Note: please refer to the manpage of defrag.f2fs(8) to get full option list.
f2fs_io f2fs_io
------- -------
The f2fs_io is a simple tool to issue various filesystem APIs as well as The f2fs_io is a simple tool to issue various filesystem APIs as well as
f2fs-specific ones, which is very useful for QA tests. f2fs-specific ones, which is very useful for QA tests.
Note that, please refer manpage of f2fs_io(8) to get full option list. Note: please refer to the manpage of f2fs_io(8) to get full option list.
Design Design
====== ======
@ -427,7 +420,7 @@ consists of a set of sections. By default, section and zone sizes are set to one
segment size identically, but users can easily modify the sizes by mkfs. segment size identically, but users can easily modify the sizes by mkfs.
F2FS splits the entire volume into six areas, and all the areas except superblock F2FS splits the entire volume into six areas, and all the areas except superblock
consists of multiple segments as described below:: consist of multiple segments as described below::
align with the zone size <-| align with the zone size <-|
|-> align with the segment size |-> align with the segment size
@ -530,7 +523,7 @@ one inode block (i.e., a file) covers::
`- direct node (1018) `- direct node (1018)
`- data (1018) `- data (1018)
Note that, all the node blocks are mapped by NAT which means the location of Note that all the node blocks are mapped by NAT which means the location of
each node is translated by the NAT table. In the consideration of the wandering each node is translated by the NAT table. In the consideration of the wandering
tree problem, F2FS is able to cut off the propagation of node updates caused by tree problem, F2FS is able to cut off the propagation of node updates caused by
leaf data writes. leaf data writes.
@ -610,7 +603,7 @@ When F2FS finds a file name in a directory, at first a hash value of the file
name is calculated. Then, F2FS scans the hash table in level #0 to find the name is calculated. Then, F2FS scans the hash table in level #0 to find the
dentry consisting of the file name and its inode number. If not found, F2FS dentry consisting of the file name and its inode number. If not found, F2FS
scans the next hash table in level #1. In this way, F2FS scans hash tables in scans the next hash table in level #1. In this way, F2FS scans hash tables in
each levels incrementally from 1 to N. In each levels F2FS needs to scan only each levels incrementally from 1 to N. In each level F2FS needs to scan only
one bucket determined by the following equation, which shows O(log(# of files)) one bucket determined by the following equation, which shows O(log(# of files))
complexity:: complexity::
@ -751,7 +744,7 @@ WRITE_LIFE_LONG " WRITE_LIFE_LONG
Fallocate(2) Policy Fallocate(2) Policy
------------------- -------------------
The default policy follows the below posix rule. The default policy follows the below POSIX rule.
Allocating disk space Allocating disk space
The default operation (i.e., mode is zero) of fallocate() allocates The default operation (i.e., mode is zero) of fallocate() allocates
@ -764,7 +757,7 @@ Allocating disk space
as a method of optimally implementing that function. as a method of optimally implementing that function.
However, once F2FS receives ioctl(fd, F2FS_IOC_SET_PIN_FILE) in prior to However, once F2FS receives ioctl(fd, F2FS_IOC_SET_PIN_FILE) in prior to
fallocate(fd, DEFAULT_MODE), it allocates on-disk blocks addressess having fallocate(fd, DEFAULT_MODE), it allocates on-disk block addressess having
zero or random data, which is useful to the below scenario where: zero or random data, which is useful to the below scenario where:
1. create(fd) 1. create(fd)
@ -783,7 +776,7 @@ Compression implementation
cluster can be compressed or not. cluster can be compressed or not.
- In cluster metadata layout, one special block address is used to indicate - In cluster metadata layout, one special block address is used to indicate
cluster is compressed one or normal one, for compressed cluster, following a cluster is a compressed one or normal one; for compressed cluster, following
metadata maps cluster to [1, 4 << n - 1] physical blocks, in where f2fs metadata maps cluster to [1, 4 << n - 1] physical blocks, in where f2fs
stores data including compress header and compressed data. stores data including compress header and compressed data.
@ -822,7 +815,7 @@ NVMe Zoned Namespace devices
- ZNS defines a per-zone capacity which can be equal or less than the - ZNS defines a per-zone capacity which can be equal or less than the
zone-size. Zone-capacity is the number of usable blocks in the zone. zone-size. Zone-capacity is the number of usable blocks in the zone.
F2fs checks if zone-capacity is less than zone-size, if it is, then any F2FS checks if zone-capacity is less than zone-size, if it is, then any
segment which starts after the zone-capacity is marked as not-free in segment which starts after the zone-capacity is marked as not-free in
the free segment bitmap at initial mount time. These segments are marked the free segment bitmap at initial mount time. These segments are marked
as permanently used so they are not allocated for writes and as permanently used so they are not allocated for writes and