Skip to content

Commit 568d2a1

Browse files
author
Jaegeuk Kim
committed
f2fs: point man pages for some f2fs utils
This patch adds some missing contexts related to f2fs-tools in f2fs documentation. Signed-off-by: Jaegeuk Kim <jaegeuk@kernel.org>
1 parent eca4873 commit 568d2a1

File tree

1 file changed

+44
-2
lines changed

1 file changed

+44
-2
lines changed

Documentation/filesystems/f2fs.rst

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,7 @@ mkfs.f2fs
315315
The mkfs.f2fs is for the use of formatting a partition as the f2fs filesystem,
316316
which builds a basic on-disk layout.
317317

318-
The options consist of:
318+
The quick options consist of:
319319

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

340+
Note that, please refer manpage of mkfs.f2fs(8) to get full option list.
341+
340342
fsck.f2fs
341343
---------
342344
The fsck.f2fs is a tool to check the consistency of an f2fs-formatted
343345
partition, which examines whether the filesystem metadata and user-made data
344346
are cross-referenced correctly or not.
345347
Note that, initial version of the tool does not fix any inconsistency.
346348

347-
The options consist of::
349+
The quick options consist of::
348350

349351
-d debug level [default:0]
350352

353+
Note that, please refer manpage of fsck.f2fs(8) to get full option list.
354+
351355
dump.f2fs
352356
---------
353357
The dump.f2fs shows the information of specific inode and dumps SSA and SIT to
@@ -371,6 +375,44 @@ Examples::
371375
# dump.f2fs -s 0~-1 /dev/sdx (SIT dump)
372376
# dump.f2fs -a 0~-1 /dev/sdx (SSA dump)
373377

378+
Note that, please refer manpage of dump.f2fs(8) to get full option list.
379+
380+
sload.f2fs
381+
----------
382+
The sload.f2fs gives a way to insert files and directories in the exisiting disk
383+
image. This tool is useful when building f2fs images given compiled files.
384+
385+
Note that, please refer manpage of sload.f2fs(8) to get full option list.
386+
387+
resize.f2fs
388+
-----------
389+
The resize.f2fs can be used when user want to resize the f2fs-formatted disk
390+
image, while keeping the stored files and directories.
391+
392+
Note that, please refer manpage of resize.f2fs(8) to get full option list.
393+
394+
resize.f2fs
395+
-----------
396+
The resize.f2fs let user resize the f2fs-formatted disk image, while preserving
397+
all the files and directories stored in the image.
398+
399+
Note that, please refer manpage of resize.f2fs(8) to get full option list.
400+
401+
defrag.f2fs
402+
-----------
403+
The defrag.f2fs can be used to defragmente scattered writtend data as well as
404+
filesystem metadata across the disk. This can improve the write speed by giving
405+
more free consecutive space.
406+
407+
Note that, please refer manpage of defrag.f2fs(8) to get full option list.
408+
409+
f2fs_io
410+
-------
411+
The f2fs_io is a simple tool to issue various filesystem APIs as well as
412+
f2fs-specific ones, which is very useful for QA tests.
413+
414+
Note that, please refer manpage of f2fs_io(8) to get full option list.
415+
374416
Design
375417
======
376418

0 commit comments

Comments
 (0)