[5/5] btrfs-progs: Doc/mkfs: Add explanation for rootdir parameter
diff mbox

Message ID 20170904064110.25951-6-quwenruo.btrfs@gmx.com
State New
Headers show

Commit Message

Qu Wenruo Sept. 4, 2017, 6:41 a.m. UTC
Original --rootdir parameter will shrink the filesystem to its minimal
size, which is quite confusing for some users.

Add extra note for this behavior.

Reported-by: Goffredo Baroncelli <kreijack@libero.it>
Signed-off-by: Qu Wenruo <quwenruo.btrfs@gmx.com>
---
 Documentation/mkfs.btrfs.asciidoc | 3 +++
 1 file changed, 3 insertions(+)

Comments

Duncan Sept. 4, 2017, 10:47 a.m. UTC | #1
Qu Wenruo posted on Mon, 04 Sep 2017 15:41:10 +0900 as excerpted:

> +NOTE: Result btrfs will be shrink to it minimal size, exceeding space will not
> +be accessible unless resized.

s/exceeding/additional/

(Exceeding could be used if reworded, but the results I came up with were
much less concise than the above with the single substitution, so...)

Patch
diff mbox

diff --git a/Documentation/mkfs.btrfs.asciidoc b/Documentation/mkfs.btrfs.asciidoc
index d53d9e26..8977761f 100644
--- a/Documentation/mkfs.btrfs.asciidoc
+++ b/Documentation/mkfs.btrfs.asciidoc
@@ -106,6 +106,9 @@  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.
++
+NOTE: Result btrfs will be shrink to it minimal size, exceeding space will not
+be accessible unless resized.
 
 *-O|--features <feature1>[,<feature2>...]*::
 A list of filesystem features turned on at mkfs time. Not all features are