btrfs-progs: Doc: Add warning and note on btrfs-convert.

Commit Message

Qu Wenruo March 26, 2015, 1:39 a.m. UTC

Although btrfs-convert can rollback converted btrfs, it still has some
limitation to ensure rollback.

Add a warning on the limitations.

Also add a note for users who decides to go on with btrfs and don't need
the rollback ability.

Signed-off-by: Qu Wenruo <[e-mail]>
---
 Documentation/btrfs-convert.txt | 9 +++++++++
 1 file changed, 9 insertions(+)

Patch

diff --git a/Documentation/btrfs-convert.txt b/Documentation/btrfs-convert.txt
index 8b3f05b..bb2f020 100644
--- a/Documentation/btrfs-convert.txt
+++ b/Documentation/btrfs-convert.txt
@@ -15,6 +15,15 @@  DESCRIPTION
 and the original filesystem image is accessible as from separate subvolume
 named 'ext2_saved' as file image.
 
+WARNING: To ensure *btrfs-convert* be able to rollback btrfs, one should never
+execute *btrfs filesystem defragment* or *btrfs balance* command on the
+converted btrfs.
+
+NOTE: If one is satisfied with converted btrfs, and not longer wants to
+rollback to ext*, it is highly recommended to remove 'ext2_saved' subvolume
+and execute *btrfs filesystem defragment* and *btrfs balance* command on the
+converted btrfs.
+
 OPTIONS
 -------
 -d|--no-datasum::