From patchwork Wed Apr 2 08:29:26 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Qu Wenruo X-Patchwork-Id: 3927511 X-Patchwork-Delegate: dave@jikos.cz Return-Path: X-Original-To: patchwork-linux-btrfs@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork2.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.19.201]) by patchwork2.web.kernel.org (Postfix) with ESMTP id 1A984BF540 for ; Wed, 2 Apr 2014 08:32:35 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 3FE9A20240 for ; Wed, 2 Apr 2014 08:32:34 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 3210720211 for ; Wed, 2 Apr 2014 08:32:33 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1758170AbaDBIao (ORCPT ); Wed, 2 Apr 2014 04:30:44 -0400 Received: from cn.fujitsu.com ([59.151.112.132]:16608 "EHLO heian.cn.fujitsu.com" rhost-flags-OK-FAIL-OK-FAIL) by vger.kernel.org with ESMTP id S1758195AbaDBI3D (ORCPT ); Wed, 2 Apr 2014 04:29:03 -0400 X-IronPort-AV: E=Sophos;i="4.97,778,1389715200"; d="scan'208";a="28775312" Received: from unknown (HELO edo.cn.fujitsu.com) ([10.167.33.5]) by heian.cn.fujitsu.com with ESMTP; 02 Apr 2014 16:26:22 +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 s328SkdO014958 for ; Wed, 2 Apr 2014 16:28:46 +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; Wed, 2 Apr 2014 16:28:53 +0800 From: Qu Wenruo To: Subject: [PATCH 15/27] btrfs-progs: Convert man page for btrfs-dedup. Date: Wed, 2 Apr 2014 16:29:26 +0800 Message-ID: <1396427378-10487-16-git-send-email-quwenruo@cn.fujitsu.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1396427378-10487-1-git-send-email-quwenruo@cn.fujitsu.com> References: <1396427378-10487-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.5 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 Although the btrfs-dedup function is not available in mainline kernel, add the man page any way and add a warning into it. Signed-off-by: Qu Wenruo --- Documentation/Makefile | 2 +- Documentation/btrfs-dedup.txt | 51 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 52 insertions(+), 1 deletion(-) create mode 100644 Documentation/btrfs-dedup.txt diff --git a/Documentation/Makefile b/Documentation/Makefile index a4f7ef0..4040951 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -29,7 +29,7 @@ MAN8_TXT += btrfs-receive.txt MAN8_TXT += btrfs-quota.txt MAN8_TXT += btrfs-qgroup.txt MAN8_TXT += btrfs-replace.txt -#MAN8_TXT += btrfs-dedup.txt +MAN8_TXT += btrfs-dedup.txt MAN_TXT = $(MAN8_TXT) MAN_XML = $(patsubst %.txt,%.xml,$(MAN_TXT)) diff --git a/Documentation/btrfs-dedup.txt b/Documentation/btrfs-dedup.txt new file mode 100644 index 0000000..d42cee6 --- /dev/null +++ b/Documentation/btrfs-dedup.txt @@ -0,0 +1,51 @@ +btrfs-dedup(8) +============== + +NAME +---- +btrfs-dedup - control the deduplication in a btrfs filesystem + +SYNOPSIS +-------- +'btrfs dedup' + +DESCRIPTION +----------- +WARNING: Deduplication function is not implemented in mainline kernel(v3.14 +yet). So most user may find this function not usable. + +'btrfs dedup' is used to control deduplication in a bttrfs filesystem. + +SUBCOMMAND +---------- +'enable' :: +Enable data deduplication support for a filesystem. + + +'disable' :: +Disable data deduplication support for a filesystem. + + +'on' [-b|--bs size] :: +Switch on data deduplication or change the dedup blocksize. + + +'off' :: +Switch off data deduplication. + +EXIT STATUS +----------- +'btrfs dedup' returns a zero exist status if it succeeds. Non zero is +returned in case of failure. + +AVAILABILITY +------------ +'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy +development, +and not suitable for any uses other than benchmarking and review. +Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for +further details. + +SEE ALSO +-------- +`mkfs.btrfs`(8),