Clarify failmode=wait documentation

Nowhere in the description of the failmode property does it clearly state how to bring a suspended pool back online. Add a few words to property description and the zpool-clear(8) man page. Reviewed-by: George Melikov <mail@gmelikov.ru> Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov> Closes openzfs#12907 Closes openzfs#9395
nicman23 · Aug 22, 2022 · 66a9d61 · 66a9d61
1 parent 8b25e91
commit 66a9d61
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/man/man7/zpoolprops.7 b/man/man7/zpoolprops.7
@@ -337,7 +337,8 @@ The behavior of such an event is determined as follows:
 .Bl -tag -width "continue"
 .It Sy wait
 Blocks all I/O access until the device connectivity is recovered and the errors
-are cleared.
+are cleared with
+.Nm zpool Cm clear .
 This is the default behavior.
 .It Sy continue
 Returns

diff --git a/man/man8/zpool-clear.8 b/man/man8/zpool-clear.8
@@ -44,9 +44,12 @@ Clears device errors in a pool.
 If no arguments are specified, all device errors within the pool are cleared.
 If one or more devices is specified, only those errors associated with the
 specified device or devices are cleared.
-If
+.Pp
+If the pool was suspended it will be brought back online provided the
+devices can be accessed.
+Pools with
 .Sy multihost
-is enabled and the pool has been suspended, this will not resume I/O.
+enabled which have been suspended cannot be resumed.
 While the pool was suspended, it may have been imported on
 another host, and resuming I/O could result in pool damage.
 .