Skip to content

Commit

Permalink
f2fs: point man pages for some f2fs utils
Browse files Browse the repository at this point in the history
This patch adds some missing contexts related to f2fs-tools in f2fs
documentation.

Signed-off-by: Jaegeuk Kim <jaegeuk@kernel.org>
  • Loading branch information
Jaegeuk Kim committed Sep 10, 2020
1 parent eca4873 commit 568d2a1
Showing 1 changed file with 44 additions and 2 deletions.
46 changes: 44 additions & 2 deletions Documentation/filesystems/f2fs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ mkfs.f2fs
The mkfs.f2fs is for the use of formatting a partition as the f2fs filesystem,
which builds a basic on-disk layout.

The options consist of:
The quick options consist of:

=============== ===========================================================
``-l [label]`` Give a volume label, up to 512 unicode name.
Expand All @@ -337,17 +337,21 @@ The options consist of:
1 is set by default, which conducts discard.
=============== ===========================================================

Note that, please refer manpage of mkfs.f2fs(8) to get full option list.

fsck.f2fs
---------
The fsck.f2fs is a tool to check the consistency of an f2fs-formatted
partition, which examines whether the filesystem metadata and user-made data
are cross-referenced correctly or not.
Note that, initial version of the tool does not fix any inconsistency.

The options consist of::
The quick options consist of::

-d debug level [default:0]

Note that, please refer manpage of fsck.f2fs(8) to get full option list.

dump.f2fs
---------
The dump.f2fs shows the information of specific inode and dumps SSA and SIT to
Expand All @@ -371,6 +375,44 @@ Examples::
# dump.f2fs -s 0~-1 /dev/sdx (SIT dump)
# dump.f2fs -a 0~-1 /dev/sdx (SSA dump)

Note that, please refer manpage of dump.f2fs(8) to get full option list.

sload.f2fs
----------
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.

Note that, please refer manpage of sload.f2fs(8) to get full option list.

resize.f2fs
-----------
The resize.f2fs can be used when user want to resize the f2fs-formatted disk
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.

Note that, please refer manpage of resize.f2fs(8) to get full option list.

defrag.f2fs
-----------
The defrag.f2fs can be used to defragmente scattered writtend data as well as
filesystem metadata across the disk. This can improve the write speed by giving
more free consecutive space.

Note that, please refer manpage of defrag.f2fs(8) to get full option list.

f2fs_io
-------
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.

Note that, please refer manpage of f2fs_io(8) to get full option list.

Design
======

Expand Down

0 comments on commit 568d2a1

Please sign in to comment.