Skip to content

Commit 86be0f8

Browse files
committed
btrfs-progs: docs: add references to btrfs(5) list
For convenience make the section list clickable, unify naming and add missing labels. [ci skip] Signed-off-by: David Sterba <[email protected]>
1 parent 34a78e8 commit 86be0f8

File tree

3 files changed

+38
-20
lines changed

3 files changed

+38
-20
lines changed

Documentation/btrfs-man5.rst

Lines changed: 36 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,23 @@ DESCRIPTION
77
This document describes topics related to BTRFS that are not specific to the
88
tools. Currently covers:
99

10-
#. mount options
11-
#. filesystem features
12-
#. checksum algorithms
13-
#. compression
14-
#. sysfs interface
15-
#. filesystem exclusive operations
16-
#. filesystem limits
17-
#. bootloader support
18-
#. file attributes
19-
#. zoned mode
20-
#. control device
21-
#. filesystems with multiple block group profiles
22-
#. seeding device
23-
#. RAID56 status and recommended practices
24-
#. glossary
25-
#. storage model, hardware considerations
10+
#. :ref:`mount options <man-btrfs5-mount-options>`
11+
#. :ref:`filesystem features <man-btrfs5-filesystem-features>`
12+
#. :ref:`swapfile support <man-btrfs5-swapfile-support>`
13+
#. :ref:`checksum algorithms <man-btrfs5-checksum-algorithms>`
14+
#. :ref:`compression <man-btrfs5-compression>`
15+
#. :ref:`sysfs interface <man-btrfs5-sysfs-interface>`
16+
#. :ref:`filesystem exclusive operations <man-btrfs5-filesystem-exclusive-operations>`
17+
#. :ref:`filesystem limits <man-btrfs5-filesystem-limits>`
18+
#. :ref:`bootloader support <man-btrfs5-bootloader-support>`
19+
#. :ref:`file attributes <man-btrfs5-file-attributes>`
20+
#. :ref:`zoned mode <man-btrfs5-zoned-mode>`
21+
#. :ref:`control device <man-btrfs5-control-device>`
22+
#. :ref:`filesystems with multiple block group profiles <man-btrfs5-filesystem-with-multiple-profiles>`
23+
#. :ref:`seeding device <man-btrfs5-seeding-device>`
24+
#. :ref:`RAID56 status and recommended practices <man-btrfs5-raid56-status>`
25+
#. :ref:`glossary <man-btrfs5-glossary>`
26+
#. :ref:`storage model, hardware considerations <man-btrfs5-storage-model>`
2627

2728
.. _man-btrfs5-mount-options:
2829

@@ -178,7 +179,7 @@ supported_checksums
178179

179180
list of checksum algorithms supported by the kernel module, the respective
180181
modules or built-in implementing the algorithms need to be present to mount
181-
the filesystem, see section :ref:`CHECKSUM ALGORITHMS<man-mkfs-checksum-algorithms>`.
182+
the filesystem, see section :ref:`CHECKSUM ALGORITHMS<man-btrfs5-checksum-algorithms>`.
182183

183184
supported_sectorsizes
184185
(since: 5.13)
@@ -199,23 +200,29 @@ zoned
199200
allocation space is partitioned into fixed-size zones that must be updated
200201
sequentially, see section :ref:`ZONED MODE<man-btrfs5-zoned-mode>`
201202

203+
.. _man-btrfs5-swapfile-support:
204+
202205
SWAPFILE SUPPORT
203206
----------------
204207

205208
.. include:: ch-swapfile.rst
206209

207-
.. _man-mkfs-checksum-algorithms:
210+
.. _man-btrfs5-checksum-algorithms:
208211

209212
CHECKSUM ALGORITHMS
210213
-------------------
211214

212215
.. include:: ch-checksumming.rst
213216

217+
.. _man-btrfs5-compression:
218+
214219
COMPRESSION
215220
-----------
216221

217222
.. include:: ch-compression.rst
218223

224+
.. _man-btrfs5-sysfs-interface:
225+
219226
SYSFS INTERFACE
220227
---------------
221228

@@ -249,16 +256,22 @@ There's an exception when a paused balance allows to start a device add
249256
operation as they don't really collide and this can be used to add more space
250257
for the balance to finish.
251258

259+
.. _man-btrfs5-filesystem-limits:
260+
252261
FILESYSTEM LIMITS
253262
-----------------
254263

255264
.. include:: ch-fs-limits.rst
256265

266+
.. _man-btrfs5-bootloader-support:
267+
257268
BOOTLOADER SUPPORT
258269
------------------
259270

260271
.. include:: ch-bootloaders.rst
261272

273+
.. _man-btrfs5-file-attributes:
274+
262275
FILE ATTRIBUTES
263276
---------------
264277

@@ -271,6 +284,7 @@ ZONED MODE
271284

272285
.. include:: ch-zoned-intro.rst
273286

287+
.. _man-btrfs5-control-device:
274288

275289
CONTROL DEVICE
276290
--------------
@@ -388,6 +402,8 @@ SEEDING DEVICE
388402

389403
.. include:: ch-seeding-device.rst
390404

405+
.. _man-btrfs5-raid56-status:
406+
391407
RAID56 STATUS AND RECOMMENDED PRACTICES
392408
---------------------------------------
393409

@@ -442,12 +458,14 @@ allocated), so in case a new device is added it may not be utilized
442458
immediately and would require a rebalance. A fixed configured stripe width is
443459
not implemented.
444460

461+
.. _man-btrfs5-glossary:
445462

446463
GLOSSARY
447464
--------
448465

449466
.. include:: ch-glossary.rst
450467

468+
.. _man-btrfs5-storage-model:
451469

452470
STORAGE MODEL, HARDWARE CONSIDERATIONS
453471
--------------------------------------

Documentation/ch-sysfs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ checksum
4343

4444
The checksum used for the mounted filesystem.
4545
This includes both the checksum type (see section
46-
:ref:`CHECKSUM ALGORITHMS<man-mkfs-checksum-algorithms>`)
46+
:ref:`CHECKSUM ALGORITHMS<man-btrfs5-checksum-algorithms>`)
4747
and the implemented driver (mostly shows if it's hardware accelerated).
4848

4949
clone_alignment

Documentation/mkfs.btrfs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ OPTIONS
3636
--csum <type>, --checksum <type>
3737
Specify the checksum algorithm. Default is *crc32c*. Valid values are *crc32c*,
3838
*xxhash*, *sha256* or *blake2*. To mount such filesystem kernel must support the
39-
checksums as well. See section :ref:`CHECKSUM ALGORITHMS<man-mkfs-checksum-algorithms>`
39+
checksums as well. See section :ref:`CHECKSUM ALGORITHMS<man-btrfs5-checksum-algorithms>`
4040
in :doc:`btrfs-man5`.
4141

4242
-d|--data <profile>

0 commit comments

Comments
 (0)