From patchwork Tue Apr 15 07:04:51 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Qu Wenruo X-Patchwork-Id: 3989481 Return-Path: X-Original-To: patchwork-linux-btrfs@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork1.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.19.201]) by patchwork1.web.kernel.org (Postfix) with ESMTP id 88BF99F3FF for ; Tue, 15 Apr 2014 07:04:03 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 9798820166 for ; Tue, 15 Apr 2014 07:04:02 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id ABCA420200 for ; Tue, 15 Apr 2014 07:04:01 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752737AbaDOHD5 (ORCPT ); Tue, 15 Apr 2014 03:03:57 -0400 Received: from cn.fujitsu.com ([59.151.112.132]:28924 "EHLO heian.cn.fujitsu.com" rhost-flags-OK-FAIL-OK-FAIL) by vger.kernel.org with ESMTP id S1752360AbaDOHDz (ORCPT ); Tue, 15 Apr 2014 03:03:55 -0400 X-IronPort-AV: E=Sophos;i="4.97,862,1389715200"; d="scan'208";a="29275520" Received: from unknown (HELO edo.cn.fujitsu.com) ([10.167.33.5]) by heian.cn.fujitsu.com with ESMTP; 15 Apr 2014 15:01:25 +0800 Received: from G08CNEXCHPEKD03.g08.fujitsu.local (localhost.localdomain [127.0.0.1]) by edo.cn.fujitsu.com (8.14.3/8.13.1) with ESMTP id s3F73pAf001776 for ; Tue, 15 Apr 2014 15:03:51 +0800 Received: from adam-work.lan (10.167.226.24) by G08CNEXCHPEKD03.g08.fujitsu.local (10.167.33.89) with Microsoft SMTP Server (TLS) id 14.3.146.2; Tue, 15 Apr 2014 15:03:57 +0800 From: Qu Wenruo To: Subject: [PATCH 3/4] btrfs-progs: Add btrfs wiki reference to man pages. Date: Tue, 15 Apr 2014 15:04:51 +0800 Message-ID: <1397545492-3054-3-git-send-email-quwenruo@cn.fujitsu.com> X-Mailer: git-send-email 1.9.2 In-Reply-To: <1397545492-3054-1-git-send-email-quwenruo@cn.fujitsu.com> References: <1397545492-3054-1-git-send-email-quwenruo@cn.fujitsu.com> MIME-Version: 1.0 X-Originating-IP: [10.167.226.24] Sender: linux-btrfs-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-btrfs@vger.kernel.org X-Spam-Status: No, score=-7.6 required=5.0 tests=BAYES_00, RCVD_IN_DNSWL_HI, RP_MATCHES_RCVD, UNPARSEABLE_RELAY autolearn=ham version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Add btrfs wiki page reference to btrfs-check/btrfsck, btrfs-restore and btrfs-device as supplement. Signed-off-by: Qu Wenruo --- Documentation/btrfs-check.txt | 5 +++++ Documentation/btrfs-device.txt | 10 ++++++++-- Documentation/btrfs-restore.txt | 4 ++++ Documentation/btrfsck.txt | 4 ++-- 4 files changed, 19 insertions(+), 4 deletions(-) diff --git a/Documentation/btrfs-check.txt b/Documentation/btrfs-check.txt index accbed4..ddd7fe7 100644 --- a/Documentation/btrfs-check.txt +++ b/Documentation/btrfs-check.txt @@ -13,6 +13,11 @@ DESCRIPTION ----------- 'btrfs check' is used to check or repair a btrfs filesystem offline. +NOTE: Since btrfs is under heavy development especially the 'btrfs check' +command, it is *highly* recommended to read the following btrfs wiki before +executing 'btrfs check' with '--repair' option: + +https://btrfs.wiki.kernel.org/index.php/Btrfsck + OPTIONS ------- -s|--support :: diff --git a/Documentation/btrfs-device.txt b/Documentation/btrfs-device.txt index 523ae4d..7a6bce5 100644 --- a/Documentation/btrfs-device.txt +++ b/Documentation/btrfs-device.txt @@ -24,16 +24,22 @@ online. Profile:: Btrfs filesystem uses data/metadata profiles to manage allocation/duplication -mechanism. Profiles like RAID level can be assigned to data and metadata separately. +mechanism. + +Profiles like RAID level can be assigned to data and metadata separately. + See `mkfs.btrfs`(8) for more details. RAID level:: -Btrfs filesystem supports most of the standard RAID level: 0/1/5/6/10. +Btrfs filesystem supports most of the standard RAID level: 0/1/5/6/10. + RAID levels can be assigned at mkfs time or online. + See `mkfs.btrfs`(8) for mkfs time RAID level assign and `btrfs-balance`(8) for online RAID level assign. ++ +NOTE: Since btrfs is under heavy development especially the RAID5/6 support, +it is *highly* recommended to read the follow btrfs wiki page to get more +updated details on RAID5/6: + +https://btrfs.wiki.kernel.org/index.php/RAID56 Balance:: `btrfs-balance`(8) subcommand can be used to balance or rebuild chunks to the diff --git a/Documentation/btrfs-restore.txt b/Documentation/btrfs-restore.txt index ea18ebb..72aa084 100644 --- a/Documentation/btrfs-restore.txt +++ b/Documentation/btrfs-restore.txt @@ -17,6 +17,10 @@ restore them into or just list the tree roots. Since current `btrfsck`(8) or `btrfs-rescue`(8) only has very limited usage, 'btrfs restore' is normally a better choice. +NOTE: It is recommended to read the following btrfs wiki page if your data is +not salvaged with default option: + +https://btrfs.wiki.kernel.org/index.php/Restore + OPTIONS ------- -s:: diff --git a/Documentation/btrfsck.txt b/Documentation/btrfsck.txt index 751c4d0..defac80 100644 --- a/Documentation/btrfsck.txt +++ b/Documentation/btrfsck.txt @@ -20,8 +20,8 @@ Now, it can only be run on an unmounted FS. WARNING: Considering it is not well-tested in real-life situations yet. If you have a broken Btrfs filesystem, btrfsck may not repair but cause -additional damages. - +additional damages. See the wiki page for more: + +https://btrfs.wiki.kernel.org/index.php/Btrfsck OPTIONS -------