path: root/Documentation/btrfs-convert.asciidoc
diff options
Diffstat (limited to 'Documentation/btrfs-convert.asciidoc')
1 files changed, 59 insertions, 0 deletions
diff --git a/Documentation/btrfs-convert.asciidoc b/Documentation/btrfs-convert.asciidoc
new file mode 100644
index 00000000..09510fa6
--- /dev/null
+++ b/Documentation/btrfs-convert.asciidoc
@@ -0,0 +1,59 @@
+btrfs-convert - convert from ext2/3/4 filesystem to btrfs or rollback
+*btrfs-convert* [options] <device>
+*btrfs-convert* is used to convert existed ext2/3/4 to btrfs filesystem,
+and the original filesystem image is accessible as from separate subvolume
+named 'ext2_saved' as file image.
+WARNING: If one hopes to rollback to ext2/3/4, they should not execute
+*btrfs balance* command on converted btrfs, since it will change the extent
+layout and make *btrfs-convert* unable to rollback.
+NOTE: If one is satisfied with converted btrfs, and not longer wants to
+rollback to ext2/3/4, it is highly recommended to remove 'ext2_saved' subvolume
+and execute *btrfs filesystem defragment* and *btrfs balance* command on the
+converted btrfs.
+Disable data checksum calculations and set NODATASUM file flag. This can speed
+up the conversion.
+Ignore xattrs and ACLs.
+Disable inlining of small files to metadata blocks.
+-N|--nodesize <SIZE>::
+Set filesystem nodesize, the tree block size in which btrfs stores data.
+The default value is 16KB (16384) or the page size, whichever is bigger.
+Must be a multiple of the sectorsize, but not larger than 65536.
+Roll back to ext2fs.
+-l|--label <LABEL>::
+set filesystem label during conversion.
+use label from the converted filesystem.
+Show progress of conversion, on by default.
+Disable detailed progress and show only the main phases of conversion.
+*btrfs-convert* will return 0 if no error happened.
+If any problems happened, 1 will be returned.