btrfs-progs: docs: RST formatting fixups

- verbatim quoting
- code-block directive spacing
- definition list spacing

Signed-off-by: David Sterba <dsterba@suse.com>
This commit is contained in:
David Sterba 2021-11-08 14:46:10 +01:00
parent b1ae8ccb21
commit 8b928ca5fb
2 changed files with 13 additions and 5 deletions

View File

@ -111,6 +111,7 @@ OPTIONS
Specify the checksum algorithm. Default is *crc32c*. Valid values are *crc32c*, Specify the checksum algorithm. Default is *crc32c*. Valid values are *crc32c*,
*xxhash*, *sha256* or *blake2*. To mount such filesystem kernel must support the *xxhash*, *sha256* or *blake2*. To mount such filesystem kernel must support the
checksums as well. checksums as well.
-d|--no-datasum -d|--no-datasum
disable data checksum calculations and set the NODATASUM file flag, this can speed disable data checksum calculations and set the NODATASUM file flag, this can speed
up the conversion up the conversion
@ -141,9 +142,11 @@ OPTIONS
.. code-block:: bash .. code-block:: bash
btrfs-convert -O list-all+ btrfs-convert -O list-all+
-p|--progress -p|--progress
show progress of conversion (a heartbeat indicator and number of inodes show progress of conversion (a heartbeat indicator and number of inodes
processed), on by default processed), on by default
--no-progress --no-progress
disable progress and show only the main phases of conversion disable progress and show only the main phases of conversion
--uuid <SPEC> --uuid <SPEC>

View File

@ -35,29 +35,30 @@ start [options] <srcdev>|<devid> <targetdev> <path>
.. note:: .. note::
The filesystem has to be resized to fully take advantage of a The filesystem has to be resized to fully take advantage of a
larger target device; this can be achieved with larger target device; this can be achieved with
`btrfs filesystem resize <devid>:max /path` ``btrfs filesystem resize <devid>:max /path``
``Options`` ``Options``
-r -r
only read from <srcdev> if no other zero-defect mirror exists. only read from *srcdev* if no other zero-defect mirror exists.
(enable this if your drive has lots of read errors, the access would be very (enable this if your drive has lots of read errors, the access would be very
slow) slow)
-f -f
force using and overwriting <targetdev> even if it looks like force using and overwriting *targetdev* even if it looks like
it contains a valid btrfs filesystem. it contains a valid btrfs filesystem.
A valid filesystem is assumed if a btrfs superblock is found which contains a A valid filesystem is assumed if a btrfs superblock is found which contains a
correct checksum. Devices that are currently mounted are correct checksum. Devices that are currently mounted are
never allowed to be used as the <targetdev>. never allowed to be used as the *targetdev*.
-B -B
no background replace. no background replace.
--enqueue --enqueue
wait if there's another exclusive operation running, otherwise continue wait if there's another exclusive operation running, otherwise continue
-K|--nodiscard -K|--nodiscard
Do not perform whole device TRIM operation on devices that are capable of that. Do not perform whole device TRIM operation on devices that are capable of that.
This does not affect discard/trim operation when the filesystem is mounted. This does not affect discard/trim operation when the filesystem is mounted.
Please see the mount option 'discard' for that in `btrfs`(5). Please see the mount option *discard* for that in ``btrfs(5)``.
status [-1] <mount_point> status [-1] <mount_point>
Print status and progress information of a running device replace operation. Print status and progress information of a running device replace operation.
@ -79,6 +80,7 @@ Given the following filesystem mounted at `/mnt/my-vault`
.. code-block:: none .. code-block:: none
Label: 'MyVault' uuid: ae20903e-b72d-49ba-b944-901fc6d888a1 Label: 'MyVault' uuid: ae20903e-b72d-49ba-b944-901fc6d888a1
Total devices 2 FS bytes used 1TiB Total devices 2 FS bytes used 1TiB
devid 1 size 1TiB used 500.00GiB path /dev/sda devid 1 size 1TiB used 500.00GiB path /dev/sda
@ -88,17 +90,20 @@ In order to replace */dev/sda* (*devid 1*) with a bigger drive located at
*/dev/sdc* you would run the following: */dev/sdc* you would run the following:
.. code-block:: bash .. code-block:: bash
btrfs replace start 1 /dev/sdc /mnt/my-vault/ btrfs replace start 1 /dev/sdc /mnt/my-vault/
You can monitor progress via: You can monitor progress via:
.. code-block:: bash .. code-block:: bash
btrfs replace status /mnt/my-vault/ btrfs replace status /mnt/my-vault/
After the replacement is complete, as per the docs at ``btrfs-filesystem(8)`` in After the replacement is complete, as per the docs at ``btrfs-filesystem(8)`` in
order to use the entire storage space of the new drive you need to run: order to use the entire storage space of the new drive you need to run:
.. code-block:: bash .. code-block:: bash
btrfs filesystem resize 1:max /mnt/my-vault/ btrfs filesystem resize 1:max /mnt/my-vault/
EXIT STATUS EXIT STATUS