Skip to content

Commit 570d1c3

Browse files
committed
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 <[email protected]>
1 parent 2700ab2 commit 570d1c3

File tree

6 files changed

+12
-11
lines changed

6 files changed

+12
-11
lines changed

Documentation/Status.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ in following ways:
5959
- :statusmok:`mostly OK`
6060
-
6161
- extents get unshared (see below)
62-
* - :ref:`Autodefrag<mount-option-autodefrag>`
62+
* - :docref:`Autodefrag <Administration:mount-option-autodefrag>`
6363
- :statusok:`OK`
6464
-
6565
-
@@ -99,7 +99,7 @@ in following ways:
9999
- :statusmok:`mostly OK`
100100
- mostly OK
101101
-
102-
* - :ref:`Degraded mount<mount-option-degraded>`
102+
* - :docref:`Degraded mount <Administration:mount-option-degraded>`
103103
- :statusok:`OK`
104104
- n/a
105105
-

Documentation/btrfs-device.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ remove [options] <device>|<devid> [<device>|<devid>...] <path>
4848
fails and cannot be enforced. The filesystem must be converted to
4949
profile(s) that would allow the removal. This can for example happen when
5050
going down from 2 devices to 1 and using the RAID1 profile. See the
51-
section :ref:`Typical use cases<man-device-typical-use-cases>`.
51+
section :docref:`Typical use cases <btrfs-device:man-device-typical-use-cases>`.
5252

5353
The operation can take long as it needs to move all data from the device.
5454

@@ -112,7 +112,8 @@ scan [options] [<device> [<device>...]]
112112
The command can be run repeatedly. Devices that have been already registered
113113
remain as such. Reloading the kernel module will drop this information. There's
114114
an alternative way of mounting multiple-device filesystem without the need for
115-
prior scanning. See the mount option :ref:`device<mount-option-device>`.
115+
prior scanning. See the mount option
116+
:docref:`device <btrfs-man5:mount-option-device>`.
116117

117118
``Options``
118119

Documentation/btrfs-scrub.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ start [-BdrRf] <path>|<device>
104104
scheduler configured for the device supports ionice. This is
105105
only supported by BFQ or Kyber but is *not* supported by
106106
mq-deadline. Please read the section about
107-
:ref:`IO limiting<scrub-io-limiting>`.
107+
:docref:`IO limiting <btrfs-scrub:scrub-io-limiting>`.
108108
-n <ioprio_classdata>
109109
set IO priority classdata (see ``ionice(1)`` manpage)
110110
-q
@@ -184,7 +184,7 @@ status [options] <path>|<device>
184184
:file:`sysfs/fs/btrfs/FSID/devinfo/scrub_speed_max`. In that case
185185
the limit is printed on the *Rate:* line if option *-d* is specified,
186186
or without it on a single-device filesystem. Read more about tat in
187-
section about :ref:`scrub IO limiting<scrub-io-limiting>`.
187+
section about :docref:`scrub IO limiting <btrfs-scrub:scrub-io-limiting>`.
188188

189189
.. code-block:: none
190190

Documentation/ch-mount-options.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ acl, noacl
2727
The support for ACL is build-time configurable (BTRFS_FS_POSIX_ACL) and
2828
mount fails if *acl* is requested but the feature is not compiled in.
2929

30-
.. _mount-option-autodefrag:
30+
.. duplabel:: mount-option-autodefrag
3131

3232
autodefrag, noautodefrag
3333
(since: 3.0, default: off)
@@ -172,7 +172,7 @@ datasum, nodatasum
172172
The cost of checksumming of the blocks in memory is much lower than the IO,
173173
modern CPUs feature hardware support of the checksumming algorithm.
174174

175-
.. _mount-option-degraded:
175+
.. duplabel:: mount-option-degraded
176176

177177
degraded
178178
(default: off)
@@ -194,7 +194,7 @@ degraded
194194
then the constraint of single/data is not satisfied and the filesystem
195195
cannot be mounted.
196196

197-
.. _mount-option-device:
197+
.. duplabel:: mount-option-device
198198

199199
device=<devicepath>
200200
Specify a path to a device that will be scanned for BTRFS filesystem during

Documentation/ch-scrub-intro.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ will continue from the last saved position.
2323
Scrub can be started only on a mounted filesystem, though it's possible to
2424
scrub only a selected device. See :ref:`btrfs scrub start<man-scrub-start>` for more.
2525

26-
.. _scrub-io-limiting:
26+
.. duplabel:: scrub-io-limiting
2727

2828
Bandwidth and IO limiting
2929
^^^^^^^^^^^^^^^^^^^^^^^^^

Documentation/ch-volume-management-intro.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ RAID level
2727
standard RAID levels. At the moment the supported ones are: RAID0, RAID1,
2828
RAID10, RAID5 and RAID6.
2929

30-
.. _man-device-typical-use-cases:
30+
.. duplabel:: man-device-typical-use-cases
3131

3232
Typical use cases
3333
-----------------

0 commit comments

Comments
 (0)