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>
This commit is contained in:
Qu Wenruo 2014-11-24 15:27:44 +08:00 committed by David Sterba
parent 751fe9b916
commit 39568fa417
2 changed files with 9 additions and 1 deletions

View File

@ -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
-------

View File

@ -2466,6 +2466,9 @@ static void print_usage(void)
fprintf(stderr, "\t-s \tsanitize file names, use once to just use garbage, use twice if you want crc collisions\n");
fprintf(stderr, "\t-w \twalk all trees instead of using extent tree, do this if your extent tree is broken\n");
fprintf(stderr, "\t-m \trestore for multiple devices\n");
fprintf(stderr, "\n");
fprintf(stderr, "\tIn the dump mode, source is the btrfs device and target is the output file (use '-' for stdout).\n");
fprintf(stderr, "\tIn the restore mode, source is the dumped image and target is the btrfs device/file.\n");
exit(1);
}