From 3c7ae0fc5139c195100eb931bc6e1148ac1f11f5 Mon Sep 17 00:00:00 2001 From: David Sterba Date: Mon, 26 Mar 2012 15:39:08 +0200 Subject: [PATCH 37/46] btrfs-progs: add man page for btrfs-convert Signed-off-by: David Sterba --- man/Makefile | 2 +- man/btrfs-convert.8.in | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 61 insertions(+), 1 deletion(-) create mode 100644 man/btrfs-convert.8.in Index: btrfs-progs-v0.20-rc1-335-gf00dd83/man/btrfs-convert.8.in =================================================================== --- /dev/null +++ btrfs-progs-v0.20-rc1-335-gf00dd83/man/btrfs-convert.8.in @@ -0,0 +1,60 @@ +.TH BTRFS-CONVERT 8 +.SH NAME +btrfs-convert \- convert ext2/ext3/ext4 filesystem image to btrfs in-place +.SH SYNOPSIS +.B btrfs-convert \fB[\-dinL]\fP \fB[\-r]\fP \fB[\-l\fP \fILABEL\fP\fB]\fP \fIdevice\fP +.SH DESCRIPTION +.B btrfs-convert +is used to convert a ext2/ext3/ext4 filesystem image to a btrfs one. This is +performed on an unmounted image. The conversion is done in-place and it's +possible to do a rollback to original fs. The original filesystem image is +accessible as a subvolume named \fIext2\_subvol\fP. + +The success of the operation depends on amount of free space in the original +filesystem, as btrfs uses this space to store it's own metadata and just adds +pointers to the data blocks. + +Duration of the operation depends on fragmentation and allocated space on the +orignal filesystem, it may take seveal hours for a terabyte-sized filesystem. + +If the operation does not finish succesfully, the image is recognized as the +original fileystem. + +.SH OPTIONS +.TP +\fB\-d\fP +Disable data checksumming. This may speed up the convert operation. +.TP +\fB\-i\fP +Do not convert ACLs. +.TP +\fB\-n\fP +Disable packing of small files. +.TP +\fB\-l\fR \fILABEL\fP +Set the label of btrfs filesystem to \fILABEL\fP. +.TP +\fB\-L\fP +Copy label from the original filesystem to btrfs. +.TP +\fB\-r\fP +Try rollback to the original filesystem. Beware that this may not always +succeed if the btrfs filesystem has been changed in a way that prevents this. + +.SH CAVEATS +The resulting filesystem will inherit the fragmentation and it's possible to +run whole filesystem defragmentation and then balance. + +The raid profile of both data and metada will be \fIsingle\fP, this is not the +same as default mkfs will create. Use balance with convert filter to change +raid profile you want. + +Security labels or quotas are not transferred to the new filesystem. + +Block sizes must be at least of btrfs supported size (currently 4KB on x86_64). + +.SH AVAILABILITY +.B btrfs-convert +is part of btrfs-progs. +.SH SEE ALSO +.BR mkfs.btrfs (8) Index: btrfs-progs-v0.20-rc1-335-gf00dd83/man/Makefile =================================================================== --- btrfs-progs-v0.20-rc1-335-gf00dd83.orig/man/Makefile +++ btrfs-progs-v0.20-rc1-335-gf00dd83/man/Makefile @@ -11,7 +11,7 @@ man8dir = $(mandir)/man8 # list only those we use .SUFFIXES: .in .gz -MANPAGES = mkfs.btrfs.8.gz btrfsck.8.gz btrfs-image.8.gz btrfs.8.gz +MANPAGES = mkfs.btrfs.8.gz btrfsck.8.gz btrfs-image.8.gz btrfs.8.gz btrfs-convert.8.gz INFILES = ${MANPAGES:.in=.gz} all: $(MANPAGES)