btrfs-progs: docs: convert btrfs-map-logical 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 f03df4f256
commit 71b1306fda
3 changed files with 40 additions and 0 deletions

View File

@ -0,0 +1,38 @@
btrfs-map-logical(8)
====================
SYNOPSIS
--------
**btrfs-map-logical** <options> <device>
DESCRIPTION
-----------
**btrfs-map-logical** can be used to find out what the physical offsets are
on the mirrors, the result is dumped to stdout by default.
Mainly used for debug purpose.
OPTIONS
-------
-l|--logical <logical_num>
Logical extent to map.
-c|--copy <copy>
Copy of the extent to read(usually 1 or 2).
-o|--output <filename>
Output file to hold the extent.
-b|--bytes <bytes>
Number of bytes to read.
EXIT STATUS
-----------
**btrfs-map-logical** will return 0 if no error happened.
If any problems happened, 1 will be returned.
SEE ALSO
--------
``mkfs.btrfs(8)``

View File

@ -61,4 +61,5 @@ man_pages = [
('btrfs-check', 'btrfs-check', 'check or repair a btrfs filesystem', '', 8), ('btrfs-check', 'btrfs-check', 'check or repair a btrfs filesystem', '', 8),
('btrfs-balance', 'btrfs-balance', 'balance block groups on a btrfs filesystem', '', 8), ('btrfs-balance', 'btrfs-balance', 'balance block groups on a btrfs filesystem', '', 8),
('btrfs-subvolume', 'btrfs-subvolume', 'manage btrfs subvolumes', '', 8), ('btrfs-subvolume', 'btrfs-subvolume', 'manage btrfs subvolumes', '', 8),
('btrfs-map-logical', 'btrfs-map-logical', 'map btrfs logical extent to physical extent', '', 8),
] ]

View File

@ -14,6 +14,7 @@ Manual pages
btrfs-find-root btrfs-find-root
btrfs-image btrfs-image
btrfs-inspect-internal btrfs-inspect-internal
btrfs-map-logical
btrfs-property btrfs-property
btrfs-qgroup btrfs-qgroup
btrfs-quota btrfs-quota