summaryrefslogtreecommitdiff
path: root/Documentation/btrfs-device.asciidoc
diff options
context:
space:
mode:
authorDavid Sterba <dsterba@suse.com>2017-07-17 17:58:50 +0200
committerDavid Sterba <dsterba@suse.com>2017-07-20 17:43:43 +0200
commitdbcbcd3bcae89f609e11100e48c2b398d908340c (patch)
tree2574f8cb87f19eac41b59a49d90e13cde63d7ca7 /Documentation/btrfs-device.asciidoc
parent167773166083815ce462678a9446cf9371a402be (diff)
btrfs-progs: docs: enhance documentation of 'btrfs device ready'
There were questions raised about the purpose of the 'dev ready' command. Link: https://marc.info/?l=linux-btrfs&m=149944574207325 Signed-off-by: David Sterba <dsterba@suse.com>
Diffstat (limited to 'Documentation/btrfs-device.asciidoc')
-rw-r--r--Documentation/btrfs-device.asciidoc7
1 files changed, 5 insertions, 2 deletions
diff --git a/Documentation/btrfs-device.asciidoc b/Documentation/btrfs-device.asciidoc
index 5e5aed61..88822ece 100644
--- a/Documentation/btrfs-device.asciidoc
+++ b/Documentation/btrfs-device.asciidoc
@@ -80,8 +80,11 @@ lowest device id.
Alias of remove kept for backward compatibility
*ready* <device>::
-Wait until all devices of a multiple-device filesystem are scanned and registered
-within the kernel module.
+Wait until all devices of a multiple-device filesystem are scanned and
+registered within the kernel module. This is to provide a way for automatic
+filesystem mounting tools to wait before the mount can start. The device scan
+is only one of the preconditions and the mount can fail for other reasons.
+Normal users usually do not need this command and may safely ignore it.
*scan* [(--all-devices|-d)|<device> [<device>...]]::
Scan devices for a btrfs filesystem and register them with the kernel module.