Clarify zinject(8) explanation of -e

Error injection of EIO or ENXIO simply sets the zio's io_error value, rather than preventing the read or write from occurring. This is important information as it affects how the probes must be used. Signed-off-by: Olaf Faaland <[email protected]> Requires-builders: style build
openzfs · Feb 14, 2018 · 16b9229 · 16b9229
1 parent 4411de2
commit 16b9229
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/man/man8/zinject.8 b/man/man8/zinject.8
@@ -112,6 +112,9 @@ Specify
 .BR "dtl" " for an ECHILD error,"
 .BR "io" " for an EIO error where reopening the device will succeed, or"
 .BR "nxio" " for an ENXIO error where reopening the device will fail."
+For EIO and ENXIO, the "failed" reads or writes still occur.  The probe simply
+sets the error value reported by the I/O pipeline so it appears the read or
+write failed.
 .TP
 .BI "\-f" " frequency"
 Only inject errors a fraction of the time. Expressed as a real number