From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-13.0 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,INCLUDES_PATCH,MAILING_LIST_MULTI, NICE_REPLY_A,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_SANE_1 autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 7746EC4727E for ; Fri, 25 Sep 2020 23:51:16 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 33B6D20878 for ; Fri, 25 Sep 2020 23:51:16 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1601077876; bh=AnoaLjW2T6AYP8LU4qjZcI4e10DD7MaqQAW8psn5yPA=; h=Subject:To:References:From:Date:In-Reply-To:List-ID:From; b=ilu12kLH0h/IAwWllCz3TW2oqTBB/+PCem+D/afjt/EDvbgdSjScM0b2dRwIXzsfy 7dhqshhlnRs/rFfWw/CRmh6btni0iYll0don7cz0sYGVg/LO69zkkdKnSE5i+Ynbvc iGQ7E/kt3p2YSxO3TVK0+B+ned2VRVC5ls2FA9tA= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729588AbgIYXvP (ORCPT ); Fri, 25 Sep 2020 19:51:15 -0400 Received: from mail.kernel.org ([198.145.29.99]:54618 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726316AbgIYXvO (ORCPT ); Fri, 25 Sep 2020 19:51:14 -0400 Received: from [192.168.0.108] (unknown [49.65.245.23]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 52ED12086A; Fri, 25 Sep 2020 23:51:13 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1601077874; bh=AnoaLjW2T6AYP8LU4qjZcI4e10DD7MaqQAW8psn5yPA=; h=Subject:To:References:From:Date:In-Reply-To:From; b=svmIVoCyXf7OAiRBGSbvGiyel3iYVkVF8HrnmYNC3TYo8dfHqnl4R463jyMCGrdq6 7SMnDXvaV4KMAHRE6Q9YrZCA8i1ot1TX7jop8BRbHLhZ0OfV9Ul/nt0Pd0yxaZG+jq 3CPzwjTC4j18rI38vratMOk7dbDQmoA8lTrnfRqM= Subject: Re: [f2fs-dev] [PATCH] f2fs: point man pages for some f2fs utils To: Jaegeuk Kim , linux-kernel@vger.kernel.org, kernel-team@android.com, linux-f2fs-devel@lists.sourceforge.net References: <20200925232256.4136799-1-jaegeuk@kernel.org> <20200925232608.GC4136545@google.com> From: Chao Yu Message-ID: <8c6ab915-1bb8-608e-9cc4-2883962deb79@kernel.org> Date: Sat, 26 Sep 2020 07:51:09 +0800 User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:45.0) Gecko/20100101 Thunderbird/45.8.0 MIME-Version: 1.0 In-Reply-To: <20200925232608.GC4136545@google.com> Content-Type: text/plain; charset=windows-1252; format=flowed Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On 2020-9-26 7:26, Jaegeuk Kim wrote: > On 09/25, Jaegeuk Kim wrote: >> This patch adds some missing contexts related to f2fs-tools in f2fs >> documentation. >> >> Signed-off-by: Jaegeuk Kim >> --- >> Documentation/filesystems/f2fs.rst | 46 ++++++++++++++++++++++++++++-- >> 1 file changed, 44 insertions(+), 2 deletions(-) >> >> diff --git a/Documentation/filesystems/f2fs.rst b/Documentation/filesystems/f2fs.rst >> index 0f37c7443d5c5..2b3aef2f5fa1f 100644 >> --- a/Documentation/filesystems/f2fs.rst >> +++ b/Documentation/filesystems/f2fs.rst >> @@ -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. 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. Reviewed-by: Chao Yu Thanks, >> + >> +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 >> ====== >> >> -- >> 2.28.0.681.g6f77f65b4e-goog > > > _______________________________________________ > Linux-f2fs-devel mailing list > Linux-f2fs-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/linux-f2fs-devel >