btrfs-progs: docs: update manual for mkfs --shrink

Signed-off-by: David Sterba <dsterba@suse.com>
This commit is contained in:
David Sterba 2017-12-07 19:56:34 +01:00
parent 0ba347f315
commit fab56e8c84
2 changed files with 13 additions and 9 deletions

View File

@ -100,18 +100,21 @@ Please see the mount option 'discard' for that in `btrfs`(5).
*-r|--rootdir <rootdir>*::
Populate the toplevel subvolume with files from 'rootdir'. This does not
require root permissions and does not mount the filesystem.
require root permissions to write the new files or to mount the filesystem.
+
NOTE: This option may enlarge the image or file to ensure it's large enough to
contain the files from 'rootdir'.
NOTE: This option may enlarge the image or file to ensure it's big enough to
contain the files from 'rootdir'. Since version 4.14.1 the filesystem size is
not minimized. Please see option '--shrink' if you need that functionality.
*--shrink*:
Shrink the filesystem to its minimal size, only works with *-r|--rootdir*
option.
*--shrink*::
Shrink the filesystem to its minimal size, only works with '--rootdir' option.
+
NOTE: If the destination is regular file, this option will also reduce the
file size. Or it will only reduce the filesystem available space.
Extra space will not be usable unless resized using 'btrfs filesystem resize'.
If the destination is a regular file, this option will also truncate the
file to the minimal size. Otherwise it will reduce the filesystem available
space. Extra space will not be usable unless the filesystem is mounted and
resized using 'btrfs filesystem resize'.
+
NOTE: prior to version 4.14.1, the shrinking was done automatically.
*-O|--features <feature1>[,<feature2>...]*::
A list of filesystem features turned on at mkfs time. Not all features are

View File

@ -352,6 +352,7 @@ static void print_usage(int ret)
printf(" creation:\n");
printf("\t-b|--byte-count SIZE set filesystem size to SIZE (on the first device)\n");
printf("\t-r|--rootdir DIR copy files from DIR to the image root directory\n");
printf("\t--shrink (with --rootdir) shrink the filled filesystem to minimal size\n");
printf("\t-K|--nodiscard do not perform whole device TRIM\n");
printf("\t-f|--force force overwrite of existing filesystem\n");
printf(" general:\n");