summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorQu Wenruo <quwenruo@cn.fujitsu.com>2014-11-24 15:27:44 +0800
committerDavid Sterba <dsterba@suse.cz>2015-01-21 17:23:23 +0100
commit39568fa417ceee3133a8cadae0bd1527adf61221 (patch)
tree5022aecd08bc2785b2e43dc0bb77ece2f6506f1c /Documentation
parent751fe9b91638c34eeae6e1b469b7ec6184d6107e (diff)
btrfs-progs: Doc: Add explain on 'source' and 'target' for btrfs-image.
Add explain on 'source' and 'target', which is somewhat confusing for users who want to restore dumped image. Signed-off-by: Qu Wenruo <quwenruo@cn.fujitsu.com> [reworded texts] Signed-off-by: David Sterba <dsterba@suse.cz>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/btrfs-image.txt7
1 files changed, 6 insertions, 1 deletions
diff --git a/Documentation/btrfs-image.txt b/Documentation/btrfs-image.txt
index b7751f90..38265171 100644
--- a/Documentation/btrfs-image.txt
+++ b/Documentation/btrfs-image.txt
@@ -13,8 +13,13 @@ DESCRIPTION
-----------
*btrfs-image* is used to create an image of a btrfs filesystem.
All data will be zeroed, but metadata and the like is preserved.
+Mainly used for debugging purposes.
+
+In the dump mode, source is the btrfs device/file and target is the output
+file (use '-' for stdout).
+
+In the restore mode (option -r), source is the dumped image and target is the btrfs device/file.
-Mainly used for debug purpose.
OPTIONS
-------