From patchwork Tue Nov 25 15:57:25 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Goffredo Baroncelli X-Patchwork-Id: 5380381 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 189129F3D0 for ; Tue, 25 Nov 2014 15:58:09 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id 48CF5200F3 for ; Tue, 25 Nov 2014 15:58:04 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 80DC2201C7 for ; Tue, 25 Nov 2014 15:57:59 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751297AbaKYP5q (ORCPT ); Tue, 25 Nov 2014 10:57:46 -0500 Received: from mail-wg0-f51.google.com ([74.125.82.51]:47071 "EHLO mail-wg0-f51.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751278AbaKYP5o (ORCPT ); Tue, 25 Nov 2014 10:57:44 -0500 Received: by mail-wg0-f51.google.com with SMTP id k14so1236004wgh.24 for ; Tue, 25 Nov 2014 07:57:43 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=aNBpwAd4fZATvtKRdl4m++QI5u64Sqff10Bs58pLb3M=; b=WN15MgpWR8DYqW2yh8/cLUV2DYIDVWb6rBbsE4iRviiKaDdhJyFSa4KyFxuwADKyzm MW4eatSev+5V6zM+YPosWTZZj0+fjIpNh0JD6YvD5sg9vPAbVqofUtjj91DTdqcZpwXi njj9k2KgSLR3GI5msYY72GyoKuJWpy7Lg7Z/NJbrow6ikEJuQZxN8YDu3dXtCFD5hXz0 93yAOBK8LaCb7KvVGCxerxhoFVbut42zH0XCtUgS/jhlzoi0UvUVyViwwDM8z9qpBrEP IODI3VhIRUTIQMqbk2pCy6qWFdxmGkGqrsa5mP9HPYuCDDHmnnOI9sYBxwFGKWqnkDJb FCug== X-Received: by 10.180.218.133 with SMTP id pg5mr32612308wic.70.1416931063295; Tue, 25 Nov 2014 07:57:43 -0800 (PST) Received: from venice.bhome (ppp-131-78.24-151.libero.it. [151.24.78.131]) by mx.google.com with ESMTPSA id n8sm2457641wjx.0.2014.11.25.07.57.41 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 25 Nov 2014 07:57:42 -0800 (PST) From: Goffredo Baroncelli X-Google-Original-From: Goffredo Baroncelli To: linux-btrfs@vger.kernel.org Cc: David Sterba , Goffredo Baroncelli Subject: [PATCH 4/4] Add man page for the 'btrfs chunk' family commands. Date: Tue, 25 Nov 2014 16:57:25 +0100 Message-Id: <1416931045-24259-5-git-send-email-kreijack@inwind.it> X-Mailer: git-send-email 2.1.3 In-Reply-To: <1416931045-24259-1-git-send-email-kreijack@inwind.it> References: <1416931045-24259-1-git-send-email-kreijack@inwind.it> Sender: linux-btrfs-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-btrfs@vger.kernel.org X-Spam-Status: No, score=-6.8 required=5.0 tests=BAYES_00, DKIM_ADSP_CUSTOM_MED, DKIM_SIGNED, FREEMAIL_FROM, RCVD_IN_DNSWL_HI, T_DKIM_INVALID, T_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-chunk(8) man page, and update btrfs(8) man page. Signed-off-by: Goffredo Baroncelli --- Documentation/Makefile | 1 + Documentation/btrfs-chunk.txt | 58 +++++++++++++++++++++++++++++++++++++++++++ Documentation/btrfs.txt | 5 ++++ 3 files changed, 64 insertions(+) create mode 100644 Documentation/btrfs-chunk.txt diff --git a/Documentation/Makefile b/Documentation/Makefile index ef4f1bd..f47f62b 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -18,6 +18,7 @@ MAN8_TXT += mkfs.btrfs.txt MAN8_TXT += btrfs-subvolume.txt MAN8_TXT += btrfs-filesystem.txt MAN8_TXT += btrfs-balance.txt +MAN8_TXT += btrfs-chunk.txt MAN8_TXT += btrfs-device.txt MAN8_TXT += btrfs-scrub.txt MAN8_TXT += btrfs-check.txt diff --git a/Documentation/btrfs-chunk.txt b/Documentation/btrfs-chunk.txt new file mode 100644 index 0000000..85d1ea6 --- /dev/null +++ b/Documentation/btrfs-chunk.txt @@ -0,0 +1,58 @@ +btrfs-chunk(8) +=============== + +NAME +---- +btrfs-chunk - control btrfs chunks + +SYNOPSIS +-------- +*btrfs chunk* + +DESCRIPTION +----------- +*btrfs chunk* is used to control the btrfs chunks. + +CHUNK DESCRIPTION +----------------- +Block devices are divided into chunks. Chunks may be +mirrored or striped across multiple devices. The mirroring/striping +arrangement is transparent to the rest of the filesystem, which simply +sees the single, logical address space that chunks are mapped into. + +There are three main types of chunks: Data, Metadata and System. Sometime +(when the device is small) Data and Metadata can be grouped togheter; in +this case the chunk is called 'Data+Metadata'. Usually the Data chunks +are used to store the file content; but if the data is small enough, this +may be stored in the Metadata chunk togheter with the filesystem data +structures. + +The striping/mirroring levels (called profiles) may be different +among the chunk types. The chunk profiles are assigned during the filesystem +creation and these can be changed by the 'btrfs balance' commands. + +See `mkfs.btrfs`(8) and `btrfs-balance`(8) for more details. + +SUBCOMMAND +---------- +*list* :: +Shows the chunks grouped by type and profile; after each group +the command lists the devices which host the chunks. +If a device is not present (i.e. the filesystem is mounted in 'degraded' mode), +it is marked as 'Missing:'. + +EXIT STATUS +----------- +*btrf chunk* returns a zero exit status if it succeeds. Non zero is +returned in case of failure. + +AVAILABILITY +------------ +*btrfs* is part of btrfs-progs. +Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for +further details. + +SEE ALSO +-------- +`mkfs.btrfs`(8), +`btrfs-balance`(8) diff --git a/Documentation/btrfs.txt b/Documentation/btrfs.txt index 3bdc6b4..fc02004 100644 --- a/Documentation/btrfs.txt +++ b/Documentation/btrfs.txt @@ -41,6 +41,10 @@ COMMANDS Balance btrfs filesystem chunks across single or several devices. + See `btrfs-balance`(8) for details. +*chunk*:: + Manage filesystem chunk; currently only listing is suported. + + See `btrfs-chunk`(8) for details. + *device*:: Manage devices managed by btrfs, including add/delete/scan and so on. + @@ -102,6 +106,7 @@ SEE ALSO `btrfs-subvolume`(8), `btrfs-filesystem`(8), `btrfs-balance`(8), +`btrfs-chunk`(8), `btrfs-device`(8), `btrfs-scrub`(8), `btrfs-check`(8),