[14/27] btrfs-progs: Convert man page for btrfs-replace.

Commit Message

Qu Wenruo April 2, 2014, 8:29 a.m. UTC

Convert man page for btrfs-replace.

Signed-off-by: Qu Wenruo <[e-mail]>
---
 Documentation/Makefile          |  2 +-
 Documentation/btrfs-replace.txt | 76 +++++++++++++++++++++++++++++++++++++++++
 2 files changed, 77 insertions(+), 1 deletion(-)
 create mode 100644 Documentation/btrfs-replace.txt

Comments

Marc MERLIN April 4, 2014, 8:29 p.m. UTC | #1

On Wed, Apr 02, 2014 at 04:29:25PM +0800, Qu Wenruo wrote:
> +If the source device is not available anymore, or if the -r option is set,
> +the data is built only using the RAID redundancy mechanisms.
> +After completion of the operation, the source device is removed from the
> +filesystem.

Woudl it make sense to add a paragraph explaining that for raid5/6,
someone should either:
1) use balance to rebuild on a new drive if one of the drives is missing
2) use btrfs device add of a new drive, then btrfs device delete of the
drive to replace, and effectively btrfs will do the same thing that
replace would

?

Thanks,
Marc

Qu Wenruo April 8, 2014, 1:20 a.m. UTC | #2

? 2014?04?05? 04:29, Marc MERLIN ??:
> On Wed, Apr 02, 2014 at 04:29:25PM +0800, Qu Wenruo wrote:
>> +If the source device is not available anymore, or if the -r option is set,
>> +the data is built only using the RAID redundancy mechanisms.
>> +After completion of the operation, the source device is removed from the
>> +filesystem.
> Woudl it make sense to add a paragraph explaining that for raid5/6,
> someone should either:
> 1) use balance to rebuild on a new drive if one of the drives is missing
> 2) use btrfs device add of a new drive, then btrfs device delete of the
> drive to replace, and effectively btrfs will do the same thing that
> replace would
>
> ?

Nice try, I think it's good to add a note paragraph for the use cases.

I'm also wondering should the same things added to btrfs-balance(8) and 
btrfs-device(8) man pages,
if added, three same paragraph will be added and the duplication 
paragraph may increase the difficulty to maintain
the documentation.

So I prefer to add the explaination about RAID5/6 to btrfs-device(8) and 
adds note on
btrfs-replace(8)/btrfs-balance(8) to refer to btrfs-device(8), since all 
of these things are about btrfs device management.

Would you prefer the modification?

Thanks,
Qu.
>
> Thanks,
> Marc

--
To unsubscribe from this list: send the line "unsubscribe linux-btrfs" in
the body of a message to [e-mail]
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Patch

diff --git a/Documentation/Makefile b/Documentation/Makefile
index 84a4859..a4f7ef0 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -28,7 +28,7 @@  MAN8_TXT += btrfs-send.txt
 MAN8_TXT += btrfs-receive.txt
 MAN8_TXT += btrfs-quota.txt
 MAN8_TXT += btrfs-qgroup.txt
-#MAN8_TXT += btrfs-replace.txt
+MAN8_TXT += btrfs-replace.txt
 #MAN8_TXT += btrfs-dedup.txt
 
 MAN_TXT = $(MAN8_TXT)
diff --git a/Documentation/btrfs-replace.txt b/Documentation/btrfs-replace.txt
new file mode 100644
index 0000000..8c5dcc4
--- /dev/null
+++ b/Documentation/btrfs-replace.txt
@@ -0,0 +1,76 @@ 
+btrfs-replace(8)
+===============
+
+NAME
+----
+btrfs-replace - replace devices managed by btrfs with other device.
+
+SYNOPSIS
+--------
+'btrfs replace' <subcommand> <args>
+
+DESCRIPTION
+-----------
+'btrfs replace' is used to replace btrfs managed devices with other device.
+
+SUBCOMMAND
+----------
+'start' [-Bfr] <srcdev>|<devid> <targetdev> <path>::
+Replace device of a btrfs filesystem.
++
+On a live filesystem, duplicate the data to the target device which
+is currently stored on the source device.
+If the source device is not available anymore, or if the -r option is set,
+the data is built only using the RAID redundancy mechanisms.
+After completion of the operation, the source device is removed from the
+filesystem.
+If the <srcdev> is a numerical value, it is assumed to be the device id
+of the filesystem which is mounted at <path>, otherwise is is
+the path to the source device. If the source device is disconnected,
+from the system, you have to use the devid parameter format.
+The <targetdev> needs to be same size or larger than the <srcdev>.
++
+`Options`
++
+-r::::
+only read from <srcdev> if no other zero-defect mirror exists.
+(enable this if your drive has lots of read errors, the access would be very
+slow)
+-f::::
+force using and overwriting <targetdev> even if it looks like
+containing a valid btrfs filesystem.
++
+A valid filesystem is assumed if a btrfs superblock is found which contains a
+correct checksum. Devices which are currently mounted are
+never allowed to be used as the <targetdev>.
+-B::::
+no background replace.
+
+'status' [-1] <mount_point>::
+Print status and progress information of a running device replace operation.
++
+`Options`
++
+-1::::
+print once instead of print continuously until the replace
+operation finishes (or is canceled)
+
+'cancel' <mount_point>::
+Cancel a running device replace operation.
+
+EXIT STATUS
+-----------
+'btrfs replace' 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),