f2fs: point man pages for some f2fs utils
Subsystems (2)
Jaegeuk Kim
maintainerPATCH 1/1 f2fs: point man pages for some f2fs utils
This patch adds some missing contexts related to f2fs-tools in f2fs documentation.
--- Documentation/filesystems/f2fs.rst | 46 ++++++++++++++++++++++++++++-- 1 file changed, 44 insertions(+), 2 deletions(-)
Documentation/filesystems/f2fs.rst +44 -2
@@ -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.
@@ -337,6 +337,8 @@ 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
@@ -344,10 +346,12 @@ 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
@@ -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 ======
Signature · 1 line
2.28.0.681.g6f77f65b4e-goog
Jaegeuk Kim
maintainerQuoted 91 lines · Jaegeuk Kim
This patch adds some missing contexts related to f2fs-tools in f2fs documentation.
Signed-off-by Jaegeuk Kim <[email protected]>--- Documentation/filesystems/f2fs.rst | 46 ++++++++++++++++++++++++++++-- 1 file changed, 44 insertions(+), 2 deletions(-)Documentation/filesystems/f2fs.rst +44
-2@@ -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.@@ -337,6 +337,8 @@ 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@@ -344,10 +346,12 @@ 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@@ -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 ======Signature · 1 line
2.28.0.681.g6f77f65b4e-goog
Quoted 49 lines · Jaegeuk Kim
Quoted 48 lines · Jaegeuk Kim
This patch adds some missing contexts related to f2fs-tools in f2fs documentation.
Signed-off-by Jaegeuk Kim <[email protected]>--- Documentation/filesystems/f2fs.rst | 46 ++++++++++++++++++++++++++++-- 1 file changed, 44 insertions(+), 2 deletions(-)Documentation/filesystems/f2fs.rst +6
-2@@ -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.@@ -337,6 +337,8 @@ 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@@ -344,10 +346,12 @@ 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@@ -371,6 +375,44 @@ Examples:: # dump.f2fs -s 0~-1 /dev/sdx (SIT dump) # dump.f2fs -a 0~-1 /dev/sdx (SSA dump)
Quoted 10 lines
Documentation/filesystems/f2fs.rst Examples:: · line 387
Quoted 10 lines
Documentation/filesystems/f2fs.rst +10
-0+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
^^^^^^^^^
Quoted 7 lines
Documentation/filesystems/f2fs.rst Examples:: · line 394
Quoted 7 lines
Documentation/filesystems/f2fs.rst +7
-0+----------- +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
^^^^^^^^^
Quoted 3 lines
Documentation/filesystems/f2fs.rst Examples:: · line 397
Quoted 3 lines
Documentation/filesystems/f2fs.rst +3
-0+----------- +The resize.f2fs let user resize the f2fs-formatted disk image, while preserving +all the files and directories stored in the image.
Can merge with above section?
I noticed that ("f2fs: Documentation edits/fixes") from Randy Dunlap has fixed this, but I think we'd better revise this in-development patch as much as possible before upstreaming it.
Otherwise, it looks good to me.
Thanks,
Quoted 30 lines
Quoted 22 lines
Documentation/filesystems/f2fs.rst +18
-1+ +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 ====== --Quoted 1 line
2.28.0.681.g6f77f65b4e-goog
_______________________________________________
Linux-f2fs-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel
Jaegeuk Kim
maintainerQuoted 79 lines · Chao Yu
Quoted 49 lines · Jaegeuk Kim
Quoted 48 lines · Jaegeuk Kim
This patch adds some missing contexts related to f2fs-tools in f2fs documentation.
Signed-off-by Jaegeuk Kim <[email protected]>--- Documentation/filesystems/f2fs.rst | 46 ++++++++++++++++++++++++++++-- 1 file changed, 44 insertions(+), 2 deletions(-)Documentation/filesystems/f2fs.rst +6
-2@@ -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.@@ -337,6 +337,8 @@ 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@@ -344,10 +346,12 @@ 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@@ -371,6 +375,44 @@ Examples:: # dump.f2fs -s 0~-1 /dev/sdx (SIT dump) # dump.f2fs -a 0~-1 /dev/sdx (SSA dump)Quoted 10 lines
Documentation/filesystems/f2fs.rst Examples:: · line 387
Quoted 10 lines
Documentation/filesystems/f2fs.rst +10
-0+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^^^^^^^^^
Quoted 7 lines
Documentation/filesystems/f2fs.rst Examples:: · line 394
Quoted 7 lines
Documentation/filesystems/f2fs.rst +7
-0+----------- +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^^^^^^^^^
Quoted 3 lines
Documentation/filesystems/f2fs.rst Examples:: · line 397
Quoted 3 lines
Documentation/filesystems/f2fs.rst +3
-0+----------- +The resize.f2fs let user resize the f2fs-formatted disk image, while preserving +all the files and directories stored in the image.Can merge with above section?
Quoted 3 lines
I noticed that ("f2fs: Documentation edits/fixes") from Randy Dunlap has
fixed this, but I think we'd better revise this in-development patch as much as possible before upstreaming it.
I can't, as it's now rc6.
Quoted 4 lines
Otherwise, it looks good to me.
Reviewed-by Chao Yu <[email protected]>
My bad to miss posting the patch. It's too late.
Quoted 33 lines
Thanks,
Quoted 30 lines
Quoted 22 lines
Documentation/filesystems/f2fs.rst +18
-1+ +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 ====== --Quoted 1 line
2.28.0.681.g6f77f65b4e-goog
_______________________________________________
Linux-f2fs-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel