From 0c2eb3f54075c1ef0fb06b8ce3ca68c2978f99d8 Mon Sep 17 00:00:00 2001 From: наб Date: Wed, 31 Mar 2021 19:49:56 +0200 Subject: fsck.zfs: implement 4/8 exit codes as suggested in manpage MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Update the fsck.zfs helper to bubble up some already-known-about errors if they are detected in the pool. health=degraded => 4/"Filesystem errors left uncorrected" health=faulted && dataset in /etc/fstab => 8/"Operational error" pool not found => 8/"Operational error" everything else => 0 Reviewed-by: Brian Behlendorf Signed-off-by: Ahelenia Ziemiańska Closes #11806 --- man/man8/fsck.zfs.8 | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) (limited to 'man/man8') diff --git a/man/man8/fsck.zfs.8 b/man/man8/fsck.zfs.8 index f681c2502..934abc677 100644 --- a/man/man8/fsck.zfs.8 +++ b/man/man8/fsck.zfs.8 @@ -22,24 +22,27 @@ .\" .\" Copyright 2013 Darik Horn . All rights reserved. .\" -.TH FSCK.ZFS 8 "Aug 24, 2020" OpenZFS +.TH FSCK.ZFS 8 "Mar 27, 2021" OpenZFS .SH NAME fsck.zfs \- Dummy ZFS filesystem checker. .SH SYNOPSIS .LP -.BI "fsck.zfs [" "options" "] <" "dataset" ">" +.BI "fsck.zfs [" "options" "] <" "dataset" ">…" .SH DESCRIPTION .LP -\fBfsck.zfs\fR is a shell stub that does nothing and always returns -true. It is installed by ZoL because some Linux distributions expect -a fsck helper for all filesystems. +\fBfsck.zfs\fR is a thin shell wrapper that at most checks the status of a +dataset's container pool. It is installed by OpenZFS because some Linux +distributions expect a fsck helper for all filesystems. +.LP +If more than one \fIdataset\fR is specified, each is checked in turn +and results binary ored. .SH OPTIONS .HP -All \fIoptions\fR and the \fIdataset\fR are ignored. +All \fIoptions\fR are ignored. .SH "NOTES" .LP @@ -47,14 +50,15 @@ ZFS datasets are checked by running \fBzpool scrub\fR on the containing pool. An individual ZFS dataset is never checked independently of its pool, which is unlike a regular filesystem. -.SH "BUGS" .LP -On some systems, if the \fIdataset\fR is in a degraded pool, then it -might be appropriate for \fBfsck.zfs\fR to return exit code 4 to -indicate an uncorrected filesystem error. +However, the +.BR fsck (8) +interface still allows it to communicate some errors: +if the \fIdataset\fR is in a degraded pool, then \fBfsck.zfs\fR will +return exit code 4 to indicate an uncorrected filesystem error. .LP Similarly, if the \fIdataset\fR is in a faulted pool and has a legacy -/etc/fstab record, then \fBfsck.zfs\fR should return exit code 8 to +/etc/fstab record, then \fBfsck.zfs\fR will return exit code 8 to indicate a fatal operational error. .SH "AUTHORS" -- cgit v1.2.3