path: root/Documentation
diff options
authorQu Wenruo <>2014-04-02 16:29:36 +0800
committerDavid Sterba <>2014-04-22 14:15:23 +0200
commit81066737e772ea3112ff2a399ca9072a76c650ee (patch)
tree44a777168dbf4563b9823c9bd9cfdef22517b8b6 /Documentation
parenta743eb1fc747dba5fdbd4305c9b6fac69bd3850d (diff)
btrfs-progs: Convert man page for fsck.btrfs.
Convert man page for fsck.btrfs. Signed-off-by: Qu Wenruo <> Signed-off-by: David Sterba <>
Diffstat (limited to 'Documentation')
2 files changed, 52 insertions, 1 deletions
diff --git a/Documentation/Makefile b/Documentation/Makefile
index 72d9f035..8802728e 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -11,7 +11,7 @@ MAN8_TXT += btrfs-map-logical.txt
MAN8_TXT += btrfs-show-super.txt
MAN8_TXT += btrfstune.txt
MAN8_TXT += btrfs-zero-log.txt
-#MAN8_TXT += fsck.btrfs.txt
+MAN8_TXT += fsck.btrfs.txt
#MAN8_TXT += mkfs.btrfs.txt
# Sub commands for btrfs
diff --git a/Documentation/fsck.btrfs.txt b/Documentation/fsck.btrfs.txt
new file mode 100644
index 00000000..52e8e4d0
--- /dev/null
+++ b/Documentation/fsck.btrfs.txt
@@ -0,0 +1,51 @@
+fsck.btrfs - do nothing, successfully
+'fsck.btrfs' [-aApy] [device...]
+'fsck.btrfs' is a type of utility that should exist for any filesystem and is
+called during system setup when the corresponding `/etc/fstab` entries
+contain non-zero value for `fs_passno` , see `fstab`(5) for more.
+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.
+If you wish to check the consistency of a BTRFS filesystem or repair a damaged
+filesystem, see `btrfs-check`(8). By default the filesystem
+consistency is checked, the repair mode is enabled via '--repair' option (use
+with care!).
+The options are all the same and detect if 'fsck.btrfs' is executed in
+non-interactive mode and exits with success,
+otherwise prints a message about btrfs check.
+There are two possible exit code returned:
+No error
+Operational error, eg. device does not exist