btrfs-progs: docs: fix warnings and links to duplicated labels

Use the new docref and duplabel syntax to fix build warnings and fix the
link targets in the pages.

[ci skip]

Signed-off-by: David Sterba <dsterba@suse.com>
This commit is contained in:
David Sterba 2024-02-13 18:07:26 +01:00
parent 2700ab22d4
commit 570d1c3cae
6 changed files with 12 additions and 11 deletions

View File

@ -59,7 +59,7 @@ in following ways:
- :statusmok:`mostly OK` - :statusmok:`mostly OK`
- -
- extents get unshared (see below) - extents get unshared (see below)
* - :ref:`Autodefrag<mount-option-autodefrag>` * - :docref:`Autodefrag <Administration:mount-option-autodefrag>`
- :statusok:`OK` - :statusok:`OK`
- -
- -
@ -99,7 +99,7 @@ in following ways:
- :statusmok:`mostly OK` - :statusmok:`mostly OK`
- mostly OK - mostly OK
- -
* - :ref:`Degraded mount<mount-option-degraded>` * - :docref:`Degraded mount <Administration:mount-option-degraded>`
- :statusok:`OK` - :statusok:`OK`
- n/a - n/a
- -

View File

@ -48,7 +48,7 @@ remove [options] <device>|<devid> [<device>|<devid>...] <path>
fails and cannot be enforced. The filesystem must be converted to fails and cannot be enforced. The filesystem must be converted to
profile(s) that would allow the removal. This can for example happen when profile(s) that would allow the removal. This can for example happen when
going down from 2 devices to 1 and using the RAID1 profile. See the going down from 2 devices to 1 and using the RAID1 profile. See the
section :ref:`Typical use cases<man-device-typical-use-cases>`. section :docref:`Typical use cases <btrfs-device:man-device-typical-use-cases>`.
The operation can take long as it needs to move all data from the device. The operation can take long as it needs to move all data from the device.
@ -112,7 +112,8 @@ scan [options] [<device> [<device>...]]
The command can be run repeatedly. Devices that have been already registered The command can be run repeatedly. Devices that have been already registered
remain as such. Reloading the kernel module will drop this information. There's remain as such. Reloading the kernel module will drop this information. There's
an alternative way of mounting multiple-device filesystem without the need for an alternative way of mounting multiple-device filesystem without the need for
prior scanning. See the mount option :ref:`device<mount-option-device>`. prior scanning. See the mount option
:docref:`device <btrfs-man5:mount-option-device>`.
``Options`` ``Options``

View File

@ -104,7 +104,7 @@ start [-BdrRf] <path>|<device>
scheduler configured for the device supports ionice. This is scheduler configured for the device supports ionice. This is
only supported by BFQ or Kyber but is *not* supported by only supported by BFQ or Kyber but is *not* supported by
mq-deadline. Please read the section about mq-deadline. Please read the section about
:ref:`IO limiting<scrub-io-limiting>`. :docref:`IO limiting <btrfs-scrub:scrub-io-limiting>`.
-n <ioprio_classdata> -n <ioprio_classdata>
set IO priority classdata (see ``ionice(1)`` manpage) set IO priority classdata (see ``ionice(1)`` manpage)
-q -q
@ -184,7 +184,7 @@ status [options] <path>|<device>
:file:`sysfs/fs/btrfs/FSID/devinfo/scrub_speed_max`. In that case :file:`sysfs/fs/btrfs/FSID/devinfo/scrub_speed_max`. In that case
the limit is printed on the *Rate:* line if option *-d* is specified, the limit is printed on the *Rate:* line if option *-d* is specified,
or without it on a single-device filesystem. Read more about tat in or without it on a single-device filesystem. Read more about tat in
section about :ref:`scrub IO limiting<scrub-io-limiting>`. section about :docref:`scrub IO limiting <btrfs-scrub:scrub-io-limiting>`.
.. code-block:: none .. code-block:: none

View File

@ -27,7 +27,7 @@ acl, noacl
The support for ACL is build-time configurable (BTRFS_FS_POSIX_ACL) and The support for ACL is build-time configurable (BTRFS_FS_POSIX_ACL) and
mount fails if *acl* is requested but the feature is not compiled in. mount fails if *acl* is requested but the feature is not compiled in.
.. _mount-option-autodefrag: .. duplabel:: mount-option-autodefrag
autodefrag, noautodefrag autodefrag, noautodefrag
(since: 3.0, default: off) (since: 3.0, default: off)
@ -172,7 +172,7 @@ datasum, nodatasum
The cost of checksumming of the blocks in memory is much lower than the IO, The cost of checksumming of the blocks in memory is much lower than the IO,
modern CPUs feature hardware support of the checksumming algorithm. modern CPUs feature hardware support of the checksumming algorithm.
.. _mount-option-degraded: .. duplabel:: mount-option-degraded
degraded degraded
(default: off) (default: off)
@ -194,7 +194,7 @@ degraded
then the constraint of single/data is not satisfied and the filesystem then the constraint of single/data is not satisfied and the filesystem
cannot be mounted. cannot be mounted.
.. _mount-option-device: .. duplabel:: mount-option-device
device=<devicepath> device=<devicepath>
Specify a path to a device that will be scanned for BTRFS filesystem during Specify a path to a device that will be scanned for BTRFS filesystem during

View File

@ -23,7 +23,7 @@ will continue from the last saved position.
Scrub can be started only on a mounted filesystem, though it's possible to Scrub can be started only on a mounted filesystem, though it's possible to
scrub only a selected device. See :ref:`btrfs scrub start<man-scrub-start>` for more. scrub only a selected device. See :ref:`btrfs scrub start<man-scrub-start>` for more.
.. _scrub-io-limiting: .. duplabel:: scrub-io-limiting
Bandwidth and IO limiting Bandwidth and IO limiting
^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^

View File

@ -27,7 +27,7 @@ RAID level
standard RAID levels. At the moment the supported ones are: RAID0, RAID1, standard RAID levels. At the moment the supported ones are: RAID0, RAID1,
RAID10, RAID5 and RAID6. RAID10, RAID5 and RAID6.
.. _man-device-typical-use-cases: .. duplabel:: man-device-typical-use-cases
Typical use cases Typical use cases
----------------- -----------------