btrfs-progs: add fsck.btrfs stub and manpage

Signed-off-by: David Sterba <dsterba@suse.cz>
Signed-off-by: Chris Mason <clm@fb.com>

2 files changed, 49 insertions, 1 deletions

diff --git a/man/Makefile b/man/Makefile
index eb91e0c5..552c9f76 100644
--- a/man/Makefile
+++ b/man/Makefile
@@ -13,7 +13,8 @@ man8dir = $(mandir)/man8
 
 MANPAGES = mkfs.btrfs.8.gz btrfsck.8.gz btrfs-image.8.gz btrfs.8.gz \
 	   btrfs-debug-tree.8.gz btrfs-show-super.8.gz btrfs-find-root.8.gz \
-	   btrfs-convert.8.gz btrfstune.8.gz btrfs-zero-log.8.gz btrfs-map-logical.8.gz
+	   btrfs-convert.8.gz btrfstune.8.gz btrfs-zero-log.8.gz btrfs-map-logical.8.gz \
+	   fsck.btrfs.8.gz
 INFILES = ${MANPAGES:.in=.gz}
 
 all: $(MANPAGES)
diff --git a/man/fsck.btrfs.8.in b/man/fsck.btrfs.8.in
new file mode 100644
index 00000000..eb21c89f
--- /dev/null
+++ b/man/fsck.btrfs.8.in
@@ -0,0 +1,47 @@
+.TH fsck.btrfs 8
+.SH NAME
+fsck.btrfs \- do nothing, successfully
+.SH SYNOPSIS
+.B fsck.btrfs
+[\fB-aApy\fP]
+[\fBdevice...\fP]
+.SH DESCRIPTION
+.B fsck.btrfs
+is a type of utility that should exist for any filesystem and is
+called during system setup when the corresponding
+.BR /etc/fstab
+entries contain non-zero value for
+.BR fs_passno
+, see
+.BR fstab(5)
+for more.
+.PP
+Traditional filesystems need to run their respective fsck utility in case the
+filesystem was not unmounted cleanly and the log needs to be replayed before
+mount. This is not needed for BTRFS. You should set fs_passno to 0.
+.PP
+If you wish to check the consistency of a BTRFS filesystem or repair a damaged
+filesystem, see
+.BR btrfs(8)
+subcommand 'check'. By default the filesystem
+consistency is checked, the repair mode is enabled via --repair option (use
+with care!).
+.SH OPTIONS
+The options detect if \fBfsck.btrfs\fP is executed in non-interactive mode and exits
+with success, otherwise prints a message about \fBbtrfs check\fP.
+.SH EXIT CODE
+There are two possible exit code returned:
+.RS
+.IP 0 5
+No errors
+.IP 8 5
+Operational error, eg. device does not exist
+.RE
+.
+.SH FILES
+.IR /etc/fstab .
+.SH SEE ALSO
+.BR btrfs (8),
+.BR fsck (8),
+.BR fstab (5),
+.\" btrfsck is intentionally left out