From: Qu Wenruo <quwenruo@cn.fujitsu.com>
To: <linux-btrfs@vger.kernel.org>
Cc: Marc MERLIN <marc@merlins.org>
Subject: [PATCH 1/2] btrfs-progs: Add device management related paragraph.
Date: Fri, 11 Apr 2014 10:43:52 +0800 [thread overview]
Message-ID: <1397184233-18535-1-git-send-email-quwenruo@cn.fujitsu.com> (raw)
Add device management related paragraph to better explain btrfs device
management.
Cc: Marc MERLIN <marc@merlins.org>
Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com>
---
Documentation/btrfs-balance.txt | 3 +++
Documentation/btrfs-device.txt | 42 +++++++++++++++++++++++++++++++++++++++++
Documentation/btrfs-replace.txt | 4 ++++
3 files changed, 49 insertions(+)
diff --git a/Documentation/btrfs-balance.txt b/Documentation/btrfs-balance.txt
index 2289fdf..1b1861c 100644
--- a/Documentation/btrfs-balance.txt
+++ b/Documentation/btrfs-balance.txt
@@ -14,6 +14,8 @@ DESCRIPTION
'btrfs balance' is used to balance chunks in a btrfs filesystem across
multiple or even single device.
+See `btrfs-device`(8) for more details about the effect on device management.
+
SUBCOMMAND
----------
<path>::
@@ -75,3 +77,4 @@ further details.
SEE ALSO
--------
`mkfs.btrfs`(8),
+`btrfs-device`(8)
diff --git a/Documentation/btrfs-device.txt b/Documentation/btrfs-device.txt
index 20d7bcd..474d411 100644
--- a/Documentation/btrfs-device.txt
+++ b/Documentation/btrfs-device.txt
@@ -14,6 +14,46 @@ DESCRIPTION
'btrfs device' is used to control the btrfs devices, since btrfs can be used
across several devices, 'btrfs device' is used for multiple device management.
+DEVICE MANAGEMENT
+-----------------
+Btrfs filesystem is capable to manage multiple devices.
+
+Btrfs filesystem use different profiles to manage different RAID level, and
+use balance to rebuild chunks, also devices can be added/removed/replace
+online.
+
+Profile::
+Btrfs filesystem use data/metadata profiles to manage allocation/duplication
+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.
+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.
+
+Balance::
+`btrfs-balance`(8) subcommand can be used to balance or rebuild chunks to the
+desired profile.
++
+Due to the fact that balance can rebuild/recovery chunks according to its RAID
+duplication if possible, so when using RAID1/5/6/10 with some devices failed
+and you just added a new device to btrfs using `btrfs-device`(8), you should
+run `btrfs-balance`(8) to rebuild the chunks.
++
+See `btrfs-balance`(8) for more details.
+
+Device add/remove/replace::
+Device can be added/removed using `btrfs-replace`(8) subcommand and replaced
+using `btrfs-replace`(8).
++
+When device is removed or replaced, btrfs will do the chunk rebuild if needed.
++
+See `btrfs-replace`(8) and this man page for more details.
+
SUBCOMMAND
----------
'add' [-Kf] <dev> [<dev>...] <path>::
@@ -73,3 +113,5 @@ further details.
SEE ALSO
--------
`mkfs.btrfs`(8),
+`btrfs-replace`(8),
+`btrfs-balance`(8)
diff --git a/Documentation/btrfs-replace.txt b/Documentation/btrfs-replace.txt
index 8c5dcc4..15a46c2 100644
--- a/Documentation/btrfs-replace.txt
+++ b/Documentation/btrfs-replace.txt
@@ -13,6 +13,9 @@ DESCRIPTION
-----------
'btrfs replace' is used to replace btrfs managed devices with other device.
+It is recommended to see `btrfs-device`(8) for more details about btrfs device
+management.
+
SUBCOMMAND
----------
'start' [-Bfr] <srcdev>|<devid> <targetdev> <path>::
@@ -74,3 +77,4 @@ further details.
SEE ALSO
--------
`mkfs.btrfs`(8),
+`btrfs-device`(8),
--
1.9.2
next reply other threads:[~2014-04-11 2:42 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-04-11 2:43 Qu Wenruo [this message]
2014-04-11 2:43 ` [PATCH 2/2] btrfs-progs: Add explain on btrfs-zero-log Qu Wenruo
2014-04-11 6:11 ` Marc MERLIN
2014-04-11 6:10 ` [PATCH 1/2] btrfs-progs: Add device management related paragraph Marc MERLIN
2014-04-11 9:08 ` Qu Wenruo
2014-04-11 17:36 ` David Sterba
2014-04-11 17:52 ` Marc MERLIN
2014-04-14 1:16 ` Qu Wenruo
2014-04-14 1:45 ` wiki vs man pages Marc MERLIN
2014-04-14 2:00 ` Qu Wenruo
2014-04-11 9:16 ` [PATCH 1/2] btrfs-progs: Add device management related paragraph Liu Bo
2014-04-11 17:34 ` David Sterba
2014-04-14 1:09 ` Qu Wenruo
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1397184233-18535-1-git-send-email-quwenruo@cn.fujitsu.com \
--to=quwenruo@cn.fujitsu.com \
--cc=linux-btrfs@vger.kernel.org \
--cc=marc@merlins.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).