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=-14.3 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,INCLUDES_PATCH,MAILING_LIST_MULTI, SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT 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 A311FC4727C for ; Fri, 25 Sep 2020 23:22:59 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 6B0972076B for ; Fri, 25 Sep 2020 23:22:59 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1601076179; bh=rmPLvtVKOQ6jecrchlehuJ98I7SN1V0oigRX8tG7HmI=; h=From:To:Cc:Subject:Date:List-ID:From; b=etR/7RjVzUgcqzBDvYh+JFFH5/6+co9jqCG3mHNrw6bNpEWforpcVsJiITcQwcZJf TLYqSSnofqDTCOUMgTAIaXa2fHnIOeFeBVtRc2B8uMeieqTvUS1F5+kgctiuAKYIov InwJededyrsE9XcHiuWW7Q3oWKtojwnSZTIyHlmI= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1729181AbgIYXW6 (ORCPT ); Fri, 25 Sep 2020 19:22:58 -0400 Received: from mail.kernel.org ([198.145.29.99]:41322 "EHLO mail.kernel.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1728606AbgIYXW6 (ORCPT ); Fri, 25 Sep 2020 19:22:58 -0400 Received: from localhost (unknown [104.132.1.66]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPSA id 7751F2076B; Fri, 25 Sep 2020 23:22:57 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1601076177; bh=rmPLvtVKOQ6jecrchlehuJ98I7SN1V0oigRX8tG7HmI=; h=From:To:Cc:Subject:Date:From; b=1JDXPPZaOcCSkxbu8Ilhdj9Z+YjQdfYwBbtQGC8qJXD3dlAqQXjvTQfa+XWeVC0/5 Rd1Ak4gI4gy2oLYSgDqUsI8tv5BuUmLLnuRHoT0Y1ZfOJp41bEHcV9//Z4ckrY4W3P Aj58gttNY2t5B0HCieSNjgKDjh94osu19lq10rnU= From: Jaegeuk Kim To: linux-kernel@vger.kernel.org, kernel-team@android.com Cc: Jaegeuk Kim Subject: [PATCH] f2fs: point man pages for some f2fs utils Date: Fri, 25 Sep 2020 16:22:56 -0700 Message-Id: <20200925232256.4136799-1-jaegeuk@kernel.org> X-Mailer: git-send-email 2.28.0.681.g6f77f65b4e-goog MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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. + +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