search

jaegeuk / f2fs-tools

Other
40 stars 31 forks source link

manpages aren't descriptive enough #8

Open ericonr opened 4 years ago

ericonr commented 4 years ago

For example, from mkfs.f2fs

.BI \-O " feature-list"
Specify a feature list in order f2fs filesystem will supports.
e.g "encrypt" and so on.

The source code for the mkfs tool shows that there are several supported options, some of which can be added after FS creation by the fsck tool.

It would be great if the man pages for mkfs showed:

and the man pages for fsck showed:

I don't know how the development works (if it's here or via mailing list), but if you can give me some tips I can try to update the man pages.

jaegeuk commented 4 years ago

Thank you for the suggestion. Yeah, if possible, can I get some help on it from you? For example, on git branch, you can change f2fs-tools/man/mkfs.f2fs.8, and then do git commit. You can send the patch to the mailing list by "git format-patch -1" && "git send-email xxx.path" to linux-f2fs-devel@lists.sourceforge.net.

Thanks,

2020년 4월 5일 (일) 오후 10:44, Érico Nogueira Rolim notifications@github.com님이 작성:

For example, from mkfs.f2fs

.BI -O " feature-list" Specify a feature list in order f2fs filesystem will supports. e.g "encrypt" and so on.

The source code for the mkfs tool shows that there are several supported options, some of which can be added after FS creation by the fsck tool.

It would be great if the man pages for mkfs showed:

  • all the optional features available
  • explanations for F2FS only features

and the man pages for fsck showed:

  • all the features that can be enabled after the FS has been created (such as encryption)

I don't know how the development works (if it's here or via mailing list), but if you can give me some tips I can try to update the man pages.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/jaegeuk/f2fs-tools/issues/8, or unsubscribe https://github.com/notifications/unsubscribe-auth/AE4EPAUT2K74DNA7YI3KH4TRLFT5NANCNFSM4MB7HOEA .

ericonr commented 4 years ago

Alright! I recently joined the mailing list, so I will send the patch as soon as I get it done. Thanks!