btrfs-progs: docs: convert fsck.btrfs to rst

Signed-off-by: David Sterba <dsterba@suse.com>
This commit is contained in:
David Sterba 2021-10-27 00:45:24 +02:00
parent df04fbceec
commit e508e6707d
3 changed files with 54 additions and 0 deletions

View file

@ -42,4 +42,5 @@ html_static_path = ['_static']
man_pages = [
('btrfs-select-super', 'btrfs-select-super', 'overwrite primary superblock with a backup copy', '', '8'),
('btrfstune', 'btrfstune', 'tune various filesystem parameters', '', 8),
('fsck.btrfs', 'fsck.btrfs', 'do nothing, successfully', '', 8),
]

View file

@ -0,0 +1,52 @@
fsck.btrfs(8)
=============
SYNOPSIS
--------
**fsck.btrfs** [-aApy] [<device>...]
DESCRIPTION
-----------
**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 filesystem consistency is checked,
the repair mode is enabled via the *--repair* option (use with care!).
OPTIONS
-------
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.
EXIT STATUS
-----------
There are two possible exit codes returned:
0
No error
8
Operational error, eg. device does not exist
FILES
-----
``/etc/fstab``
SEE ALSO
--------
``btrfs(8)``,
``fsck(8)``,
``fstab(5)``

View file

@ -8,6 +8,7 @@ Manual pages
btrfs-select-super
btrfstune
fsck.btrfs
Indices
=======