From f463c0dcc10ae0c65ec4c89995f4c9cdb9eaa925 Mon Sep 17 00:00:00 2001 From: David Sterba Date: Fri, 16 Feb 2024 09:37:55 +0100 Subject: [PATCH] btrfs-progs: docs: use manref role for all manual page references [ci skip] Signed-off-by: David Sterba --- Documentation/Glossary.rst | 6 +++--- Documentation/Interoperability.rst | 6 ++---- Documentation/btrfs-balance.rst | 2 +- Documentation/btrfs-device.rst | 4 ++-- Documentation/btrfs-filesystem.rst | 6 +++--- Documentation/btrfs-ioctl.rst | 2 +- Documentation/btrfs-man5.rst | 14 +++++++------- Documentation/btrfs-property.rst | 8 ++++---- Documentation/btrfs-receive.rst | 2 +- Documentation/btrfs-restore.rst | 2 +- Documentation/btrfs-scrub.rst | 4 ++-- Documentation/btrfs-subvolume.rst | 2 +- Documentation/btrfs.rst | 4 ++-- Documentation/btrfstune.rst | 2 +- Documentation/ch-file-attributes.rst | 16 ++++++++-------- Documentation/ch-fs-limits.rst | 2 +- Documentation/ch-mount-options.rst | 12 ++++++------ Documentation/ch-scrub-intro.rst | 4 ++-- Documentation/ch-swapfile.rst | 4 ++-- Documentation/fsck.btrfs.rst | 6 +++--- Documentation/mkfs.btrfs.rst | 2 +- 21 files changed, 54 insertions(+), 56 deletions(-) diff --git a/Documentation/Glossary.rst b/Documentation/Glossary.rst index 185621b4..9ca9ea2f 100644 --- a/Documentation/Glossary.rst +++ b/Documentation/Glossary.rst @@ -142,7 +142,7 @@ fallocate Command line tool in util-linux, and a syscall, that reserves space in the filesystem for a file, without actually writing any file data to the filesystem. First data write will turn the preallocated extents - into regular ones. See *fallocate(1)* and *fallocate(2)* manual pages + into regular ones. See :manref:`fallocate(1)` and :manref:`fallocate(2)` manual pages for more details. filefrag @@ -160,12 +160,12 @@ free space cache fsync On Unix and Unix-like operating systems (of which Linux is the latter), - the ``fsync()`` system call causes all buffered file + the :manref:`fsync(2)` system call causes all buffered file descriptor related data changes to be flushed to the underlying block device. When a file is modified on a modern operating system the changes are generally not written to the disk immediately but rather those changes are buffered in memory for reasons of performance, - calling ``fsync()`` causes any in-memory changes to be written + calling :manref:`fsync(2)` causes any in-memory changes to be written to disk. generation diff --git a/Documentation/Interoperability.rst b/Documentation/Interoperability.rst index 39c0ca73..8b8d5220 100644 --- a/Documentation/Interoperability.rst +++ b/Documentation/Interoperability.rst @@ -13,8 +13,7 @@ data. This can be used to limit bandwidth or for accounting. The cgroups can be configured directly or e.g. via systemd directives *IOAccounting*, *IOWeight* etc. -See also: -https://www.man7.org/linux/man-pages/man5/systemd.resource-control.5.html +See also :manref:`systemd.resource-control(5)`. .. _interop-fsverity: @@ -83,8 +82,7 @@ Example of server side export: /mnt/data/subvolume1 192.168.1.2/24(fsid=12345,rw,sync) /mnt/data/subvolume2 192.168.1.2/24(fsid=23456,rw,sync) -See also: -https://www.man7.org/linux/man-pages/man5/exports.5.html +See also :manref:`exports(5)`. .. _interop-samba: diff --git a/Documentation/btrfs-balance.rst b/Documentation/btrfs-balance.rst index 8522ad96..f2f0bda5 100644 --- a/Documentation/btrfs-balance.rst +++ b/Documentation/btrfs-balance.rst @@ -68,7 +68,7 @@ start [options] or *raid6* --background|--bg - run the balance operation asynchronously in the background, uses ``fork(2)`` to + run the balance operation asynchronously in the background, uses :manref:`fork(2)` to start the process that calls the kernel ioctl --enqueue diff --git a/Documentation/btrfs-device.rst b/Documentation/btrfs-device.rst index f741f78e..1a42b963 100644 --- a/Documentation/btrfs-device.rst +++ b/Documentation/btrfs-device.rst @@ -23,9 +23,9 @@ add [-Kf] [...] Add device(s) to the filesystem identified by *path*. If applicable, a whole device discard (TRIM) operation is performed prior to - adding the device. A device with existing filesystem detected by ``blkid(8)`` + adding the device. A device with existing filesystem detected by :manref:`blkid(8)` will prevent device addition and has to be forced. Alternatively the filesystem - can be wiped from the device using e.g. the ``wipefs(8)`` tool. + can be wiped from the device using e.g. the :manref:`wipefs(8)` tool. The operation is instant and does not affect existing data. The operation merely adds the device to the filesystem structures and creates some block groups diff --git a/Documentation/btrfs-filesystem.rst b/Documentation/btrfs-filesystem.rst index 54069ce4..83207a5a 100644 --- a/Documentation/btrfs-filesystem.rst +++ b/Documentation/btrfs-filesystem.rst @@ -206,7 +206,7 @@ mkswapfile [-s size] file activated swapfile cannot be balanced. Swapfile creation can be achieved by standalone commands too. Activation - needs to be done by command ``swapon(8)``. See also command + needs to be done by command :manref:`swapon(8)`. See also command :command:`btrfs inspect-internal map-swapfile` and the :doc:`Swapfile feature` description. @@ -252,7 +252,7 @@ resize [options] [:][+/-][kKmMgGtTpPeE]|[:]max partition. If you wish to enlarge/reduce a filesystem, you must make sure you can expand the partition before enlarging the filesystem and shrink the partition after reducing the size of the filesystem. This can done using - ``fdisk(8)`` or ``parted(8)`` to delete the existing partition and recreate + :manref:`fdisk(8)` or :manref:`parted(8)` to delete the existing partition and recreate it with the new desired size. When recreating the partition make sure to use the same starting partition offset as before. @@ -301,7 +301,7 @@ show [options] [|||