mirror of
https://github.com/kdave/btrfs-progs
synced 2024-12-18 04:15:32 +00:00
btrfs-progs: docs: use manref role for all manual page references
[ci skip] Signed-off-by: David Sterba <dsterba@suse.com>
This commit is contained in:
parent
831a23616a
commit
f463c0dcc1
@ -142,7 +142,7 @@ fallocate
|
|||||||
Command line tool in util-linux, and a syscall, that reserves space in
|
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 for a file, without actually writing any file data to
|
||||||
the filesystem. First data write will turn the preallocated extents
|
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.
|
for more details.
|
||||||
|
|
||||||
filefrag
|
filefrag
|
||||||
@ -160,12 +160,12 @@ free space cache
|
|||||||
|
|
||||||
fsync
|
fsync
|
||||||
On Unix and Unix-like operating systems (of which Linux is the latter),
|
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
|
descriptor related data changes to be flushed to the underlying block
|
||||||
device. When a file is modified on a modern operating system the
|
device. When a file is modified on a modern operating system the
|
||||||
changes are generally not written to the disk immediately but rather
|
changes are generally not written to the disk immediately but rather
|
||||||
those changes are buffered in memory for reasons of performance,
|
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.
|
to disk.
|
||||||
|
|
||||||
generation
|
generation
|
||||||
|
@ -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*,
|
be configured directly or e.g. via systemd directives *IOAccounting*,
|
||||||
*IOWeight* etc.
|
*IOWeight* etc.
|
||||||
|
|
||||||
See also:
|
See also :manref:`systemd.resource-control(5)`.
|
||||||
https://www.man7.org/linux/man-pages/man5/systemd.resource-control.5.html
|
|
||||||
|
|
||||||
.. _interop-fsverity:
|
.. _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/subvolume1 192.168.1.2/24(fsid=12345,rw,sync)
|
||||||
/mnt/data/subvolume2 192.168.1.2/24(fsid=23456,rw,sync)
|
/mnt/data/subvolume2 192.168.1.2/24(fsid=23456,rw,sync)
|
||||||
|
|
||||||
See also:
|
See also :manref:`exports(5)`.
|
||||||
https://www.man7.org/linux/man-pages/man5/exports.5.html
|
|
||||||
|
|
||||||
.. _interop-samba:
|
.. _interop-samba:
|
||||||
|
|
||||||
|
@ -68,7 +68,7 @@ start [options] <path>
|
|||||||
or *raid6*
|
or *raid6*
|
||||||
|
|
||||||
--background|--bg
|
--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
|
start the process that calls the kernel ioctl
|
||||||
|
|
||||||
--enqueue
|
--enqueue
|
||||||
|
@ -23,9 +23,9 @@ add [-Kf] <device> [<device>...] <path>
|
|||||||
Add device(s) to the filesystem identified by *path*.
|
Add device(s) to the filesystem identified by *path*.
|
||||||
|
|
||||||
If applicable, a whole device discard (TRIM) operation is performed prior to
|
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
|
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
|
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
|
adds the device to the filesystem structures and creates some block groups
|
||||||
|
@ -206,7 +206,7 @@ mkswapfile [-s size] file
|
|||||||
activated swapfile cannot be balanced.
|
activated swapfile cannot be balanced.
|
||||||
|
|
||||||
Swapfile creation can be achieved by standalone commands too. Activation
|
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`
|
:command:`btrfs inspect-internal map-swapfile`
|
||||||
and the :doc:`Swapfile feature<Swapfile>` description.
|
and the :doc:`Swapfile feature<Swapfile>` description.
|
||||||
|
|
||||||
@ -252,7 +252,7 @@ resize [options] [<devid>:][+/-]<size>[kKmMgGtTpPeE]|[<devid>:]max <path>
|
|||||||
partition. If you wish to enlarge/reduce a filesystem, you must make sure you
|
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
|
can expand the partition before enlarging the filesystem and shrink the
|
||||||
partition after reducing the size of the filesystem. This can done using
|
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
|
it with the new desired size. When recreating the partition make sure to use
|
||||||
the same starting partition offset as before.
|
the same starting partition offset as before.
|
||||||
|
|
||||||
@ -301,7 +301,7 @@ show [options] [<path>|<uuid>|<device>|<label>]
|
|||||||
show sizes in TiB, or TB with --si
|
show sizes in TiB, or TB with --si
|
||||||
|
|
||||||
sync <path>
|
sync <path>
|
||||||
Force a sync of the filesystem at *path*, similar to the ``sync(1)`` command. In
|
Force a sync of the filesystem at *path*, similar to the :manref:`sync(1)` command. In
|
||||||
addition, it starts cleaning of deleted subvolumes. To wait for the subvolume
|
addition, it starts cleaning of deleted subvolumes. To wait for the subvolume
|
||||||
deletion to complete use the :command:`btrfs subvolume sync` command.
|
deletion to complete use the :command:`btrfs subvolume sync` command.
|
||||||
|
|
||||||
|
@ -897,4 +897,4 @@ AVAILABILITY
|
|||||||
|
|
||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
ioctl(2)
|
:manref:`ioctl(2)`
|
||||||
|
@ -149,7 +149,7 @@ RAID56
|
|||||||
rmdir_subvol
|
rmdir_subvol
|
||||||
(since: 4.18)
|
(since: 4.18)
|
||||||
|
|
||||||
indicate that ``rmdir(2)`` syscall can delete an empty subvolume just like an
|
indicate that :manref:`rmdir(2)` syscall can delete an empty subvolume just like an
|
||||||
ordinary directory. Note that this feature only depends on the kernel version.
|
ordinary directory. Note that this feature only depends on the kernel version.
|
||||||
|
|
||||||
skinny_metadata
|
skinny_metadata
|
||||||
@ -440,11 +440,11 @@ STORAGE MODEL, HARDWARE CONSIDERATIONS
|
|||||||
SEE ALSO
|
SEE ALSO
|
||||||
--------
|
--------
|
||||||
|
|
||||||
``acl(5)``,
|
:manref:`acl(5)`,
|
||||||
:doc:`btrfs`,
|
:doc:`btrfs`,
|
||||||
``chattr(1)``,
|
:manref:`chattr(1)`,
|
||||||
``fstrim(8)``,
|
:manref:`fstrim(8)`,
|
||||||
``ioctl(2)``,
|
:manref:`ioctl(2)`,
|
||||||
:doc:`mkfs.btrfs`,
|
:doc:`mkfs.btrfs`,
|
||||||
``mount(8)``,
|
:manref:`mount(8)`,
|
||||||
``swapon(8)``
|
:manref:`swapon(8)`
|
||||||
|
@ -14,8 +14,8 @@ The object can be an inode (file or directory), subvolume or the whole
|
|||||||
filesystem.
|
filesystem.
|
||||||
|
|
||||||
**btrfs property** provides an unified and user-friendly method to tune different
|
**btrfs property** provides an unified and user-friendly method to tune different
|
||||||
btrfs properties instead of using the traditional method like ``chattr(1)`` or
|
btrfs properties instead of using the traditional method like :manref:`chattr(1)` or
|
||||||
``lsattr(1)``.
|
:manref:`lsattr(1)`.
|
||||||
|
|
||||||
Object types
|
Object types
|
||||||
^^^^^^^^^^^^
|
^^^^^^^^^^^^
|
||||||
@ -125,5 +125,5 @@ SEE ALSO
|
|||||||
--------
|
--------
|
||||||
|
|
||||||
:doc:`mkfs.btrfs`,
|
:doc:`mkfs.btrfs`,
|
||||||
``lsattr(1)``,
|
:manref:`lsattr(1)`,
|
||||||
``chattr(1)``
|
:manref:`chattr(1)`
|
||||||
|
@ -36,7 +36,7 @@ A subvolume is made read-only after the receiving process finishes successfully
|
|||||||
read the stream from *FILE* instead of stdin,
|
read the stream from *FILE* instead of stdin,
|
||||||
|
|
||||||
-C|--chroot
|
-C|--chroot
|
||||||
confine the process to *path* using ``chroot(1)``
|
confine the process to *path* using :manref:`chroot(1)`
|
||||||
|
|
||||||
-e
|
-e
|
||||||
terminate after receiving an *end cmd* marker in the stream.
|
terminate after receiving an *end cmd* marker in the stream.
|
||||||
|
@ -71,7 +71,7 @@ OPTIONS
|
|||||||
dry run (only list files that would be recovered)
|
dry run (only list files that would be recovered)
|
||||||
|
|
||||||
--path-regex <regex>
|
--path-regex <regex>
|
||||||
restore only filenames matching a regular expression (``regex(7)``)
|
restore only filenames matching a regular expression (:manref:`regex(7)`)
|
||||||
with a mandatory format
|
with a mandatory format
|
||||||
|
|
||||||
``^/(|home(|/username(|/Desktop(|/.*))))$``
|
``^/(|home(|/username(|/Desktop(|/.*))))$``
|
||||||
|
@ -100,13 +100,13 @@ start [-BdrRf] <path>|<device>
|
|||||||
``Deprecated options``
|
``Deprecated options``
|
||||||
|
|
||||||
-c <ioprio_class>
|
-c <ioprio_class>
|
||||||
set IO priority class (see ``ionice(1)`` manual page) if the IO
|
set IO priority class (see :manref:`ionice(1)` manual page) if the IO
|
||||||
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
|
||||||
:docref:`IO limiting <btrfs-scrub: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 :manref:`ionice(1)` manpage)
|
||||||
-q
|
-q
|
||||||
(deprecated) alias for global *-q* option
|
(deprecated) alias for global *-q* option
|
||||||
|
|
||||||
|
@ -311,4 +311,4 @@ SEE ALSO
|
|||||||
:doc:`btrfs-quota`,
|
:doc:`btrfs-quota`,
|
||||||
:doc:`btrfs-send`,
|
:doc:`btrfs-send`,
|
||||||
:doc:`mkfs.btrfs`,
|
:doc:`mkfs.btrfs`,
|
||||||
``mount(8)``
|
:manref:`mount(8)`
|
||||||
|
@ -37,10 +37,10 @@ If the command name is ambiguous, the list of conflicting options is
|
|||||||
printed.
|
printed.
|
||||||
|
|
||||||
*Sizes*, both upon input and output, can be expressed in either SI or IEC-I
|
*Sizes*, both upon input and output, can be expressed in either SI or IEC-I
|
||||||
units (see `numfmt(1) <https://www.man7.org/linux/man-pages/man1/numfmt.1.html>`_)
|
units (see :manref:`numfmt(1)`)
|
||||||
with the suffix `B` appended.
|
with the suffix `B` appended.
|
||||||
All numbers will be formatted according to the rules of the `C` locale
|
All numbers will be formatted according to the rules of the `C` locale
|
||||||
(ignoring the shell locale, see `locale(7) <https://man7.org/linux/man-pages/man7/locale.7.html>`_).
|
(ignoring the shell locale, see :manref:`locale(7)`).
|
||||||
|
|
||||||
For an overview of a given command use :command:`btrfs command --help`
|
For an overview of a given command use :command:`btrfs command --help`
|
||||||
or :command:`btrfs [command...] --help --full` to print all available options.
|
or :command:`btrfs [command...] --help --full` to print all available options.
|
||||||
|
@ -105,7 +105,7 @@ OPTIONS
|
|||||||
-U <UUID>
|
-U <UUID>
|
||||||
Change fsid to *UUID* in all metadata blocks.
|
Change fsid to *UUID* in all metadata blocks.
|
||||||
|
|
||||||
The *UUID* should be a 36 bytes string in ``printf(3)`` format
|
The *UUID* should be a 36 bytes string in :manref:`printf(3)` format
|
||||||
``%08x-%04x-%04x-%04x-%012x``.
|
``%08x-%04x-%04x-%04x-%012x``.
|
||||||
If there is a previous unfinished fsid change, it will continue only if the
|
If there is a previous unfinished fsid change, it will continue only if the
|
||||||
*UUID* matches the unfinished one or if you use the option *-u*.
|
*UUID* matches the unfinished one or if you use the option *-u*.
|
||||||
|
@ -2,14 +2,14 @@ The btrfs filesystem supports setting file attributes or flags. Note there are
|
|||||||
old and new interfaces, with confusing names. The following list should clarify
|
old and new interfaces, with confusing names. The following list should clarify
|
||||||
that:
|
that:
|
||||||
|
|
||||||
* *attributes*: ``chattr(1)`` or ``lsattr(1)`` utilities (the ioctls are
|
* *attributes*: :manref:`chattr(1)` or :manref:`lsattr(1)` utilities (the ioctls are
|
||||||
FS_IOC_GETFLAGS and FS_IOC_SETFLAGS), due to the ioctl names the attributes
|
FS_IOC_GETFLAGS and FS_IOC_SETFLAGS), due to the ioctl names the attributes
|
||||||
are also called flags
|
are also called flags
|
||||||
* *xflags*: to distinguish from the previous, it's extended flags, with tunable
|
* *xflags*: to distinguish from the previous, it's extended flags, with tunable
|
||||||
bits similar to the attributes but extensible and new bits will be added in
|
bits similar to the attributes but extensible and new bits will be added in
|
||||||
the future (the ioctls are FS_IOC_FSGETXATTR and FS_IOC_FSSETXATTR but they
|
the future (the ioctls are FS_IOC_FSGETXATTR and FS_IOC_FSSETXATTR but they
|
||||||
are not related to extended attributes that are also called xattrs), there's
|
are not related to extended attributes that are also called xattrs), there's
|
||||||
no standard tool to change the bits, there's support in ``xfs_io(8)`` as
|
no standard tool to change the bits, there's support in :manref:`xfs_io(8)` as
|
||||||
command **xfs_io -c chattr**
|
command **xfs_io -c chattr**
|
||||||
|
|
||||||
Attributes
|
Attributes
|
||||||
@ -39,11 +39,11 @@ C
|
|||||||
empty files.
|
empty files.
|
||||||
|
|
||||||
d
|
d
|
||||||
*no dump*, makes sense with 3rd party tools like ``dump(8)``, on BTRFS the
|
*no dump*, makes sense with 3rd party tools like :manref:`dump(8)`, on BTRFS the
|
||||||
attribute can be set/unset but no other special handling is done
|
attribute can be set/unset but no other special handling is done
|
||||||
|
|
||||||
D
|
D
|
||||||
*synchronous directory updates*, for more details search ``open(2)`` for *O_SYNC*
|
*synchronous directory updates*, for more details search :manref:`open(2)` for *O_SYNC*
|
||||||
and *O_DSYNC*
|
and *O_DSYNC*
|
||||||
|
|
||||||
i
|
i
|
||||||
@ -52,24 +52,24 @@ i
|
|||||||
|
|
||||||
m
|
m
|
||||||
*no compression*, permanently turn off compression on the given file. Any
|
*no compression*, permanently turn off compression on the given file. Any
|
||||||
compression mount options will not affect this file. (``chattr`` support added in
|
compression mount options will not affect this file. (:manref:`chattr(1)` support added in
|
||||||
1.46.2)
|
1.46.2)
|
||||||
|
|
||||||
When set on a directory, all newly created files will inherit this attribute.
|
When set on a directory, all newly created files will inherit this attribute.
|
||||||
This attribute cannot be set with *c* at the same time.
|
This attribute cannot be set with *c* at the same time.
|
||||||
|
|
||||||
S
|
S
|
||||||
*synchronous updates*, for more details search ``open(2)`` for *O_SYNC* and
|
*synchronous updates*, for more details search :manref:`open(2)` for *O_SYNC* and
|
||||||
*O_DSYNC*
|
*O_DSYNC*
|
||||||
|
|
||||||
No other attributes are supported. For the complete list please refer to the
|
No other attributes are supported. For the complete list please refer to the
|
||||||
``chattr(1)`` manual page.
|
:manref:`chattr(1)` manual page.
|
||||||
|
|
||||||
XFLAGS
|
XFLAGS
|
||||||
^^^^^^
|
^^^^^^
|
||||||
|
|
||||||
There's an overlap of letters assigned to the bits with the attributes, this list
|
There's an overlap of letters assigned to the bits with the attributes, this list
|
||||||
refers to what ``xfs_io(8)`` provides:
|
refers to what :manref:`xfs_io(8)` provides:
|
||||||
|
|
||||||
i
|
i
|
||||||
*immutable*, same as the attribute
|
*immutable*, same as the attribute
|
||||||
|
@ -9,7 +9,7 @@ maximum symlink target length
|
|||||||
it's 4095 due to the system limit PATH_MAX
|
it's 4095 due to the system limit PATH_MAX
|
||||||
|
|
||||||
The symlink target may not be a valid path, i.e. the path name components
|
The symlink target may not be a valid path, i.e. the path name components
|
||||||
can exceed the limits (NAME_MAX), there's no content validation at ``symlink(3)``
|
can exceed the limits (NAME_MAX), there's no content validation at :manref:`symlink(3)`
|
||||||
creation.
|
creation.
|
||||||
|
|
||||||
maximum number of inodes
|
maximum number of inodes
|
||||||
|
@ -2,7 +2,7 @@ BTRFS SPECIFIC MOUNT OPTIONS
|
|||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
This section describes mount options specific to BTRFS. For the generic mount
|
This section describes mount options specific to BTRFS. For the generic mount
|
||||||
options please refer to ``mount(8)`` manual page. The options are sorted alphabetically
|
options please refer to :manref:`mount(8)` manual page. The options are sorted alphabetically
|
||||||
(discarding the *no* prefix).
|
(discarding the *no* prefix).
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
@ -22,7 +22,7 @@ acl, noacl
|
|||||||
(default: on)
|
(default: on)
|
||||||
|
|
||||||
Enable/disable support for POSIX Access Control Lists (ACLs). See the
|
Enable/disable support for POSIX Access Control Lists (ACLs). See the
|
||||||
``acl(5)`` manual page for more information about ACLs.
|
:manref:`acl(5)` manual page for more information about ACLs.
|
||||||
|
|
||||||
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.
|
||||||
@ -147,7 +147,7 @@ datacow, nodatacow
|
|||||||
|
|
||||||
Enable data copy-on-write for newly created files.
|
Enable data copy-on-write for newly created files.
|
||||||
*Nodatacow* implies *nodatasum*, and disables *compression*. All files created
|
*Nodatacow* implies *nodatasum*, and disables *compression*. All files created
|
||||||
under *nodatacow* are also set the NOCOW file attribute (see ``chattr(1)``).
|
under *nodatacow* are also set the NOCOW file attribute (see :manref:`chattr(1)`).
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
If *nodatacow* or *nodatasum* are enabled, compression is disabled.
|
If *nodatacow* or *nodatasum* are enabled, compression is disabled.
|
||||||
@ -162,7 +162,7 @@ datasum, nodatasum
|
|||||||
Enable data checksumming for newly created files.
|
Enable data checksumming for newly created files.
|
||||||
*Datasum* implies *datacow*, i.e. the normal mode of operation. All files created
|
*Datasum* implies *datacow*, i.e. the normal mode of operation. All files created
|
||||||
under *nodatasum* inherit the "no checksums" property, however there's no
|
under *nodatasum* inherit the "no checksums" property, however there's no
|
||||||
corresponding file attribute (see ``chattr(1)``).
|
corresponding file attribute (see :manref:`chattr(1)`).
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
If *nodatacow* or *nodatasum* are enabled, compression is disabled.
|
If *nodatacow* or *nodatasum* are enabled, compression is disabled.
|
||||||
@ -468,7 +468,7 @@ user_subvol_rm_allowed
|
|||||||
of the source subvolume, the subvolume deletion has been restricted for that
|
of the source subvolume, the subvolume deletion has been restricted for that
|
||||||
reason. The subvolume creation has been restricted but this mount option is
|
reason. The subvolume creation has been restricted but this mount option is
|
||||||
still required. This is a usability issue.
|
still required. This is a usability issue.
|
||||||
Since 4.18, the ``rmdir(2)`` syscall can delete an empty subvolume just like an
|
Since 4.18, the :manref:`rmdir(2)` syscall can delete an empty subvolume just like an
|
||||||
ordinary directory. Whether this is possible can be detected at runtime, see
|
ordinary directory. Whether this is possible can be detected at runtime, see
|
||||||
*rmdir_subvol* feature in *FILESYSTEM FEATURES*.
|
*rmdir_subvol* feature in *FILESYSTEM FEATURES*.
|
||||||
|
|
||||||
@ -496,7 +496,7 @@ inode_cache, noinode_cache
|
|||||||
NOTES ON GENERIC MOUNT OPTIONS
|
NOTES ON GENERIC MOUNT OPTIONS
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
Some of the general mount options from ``mount(8)`` that affect BTRFS and are
|
Some of the general mount options from :manref:`mount(8)` that affect BTRFS and are
|
||||||
worth mentioning.
|
worth mentioning.
|
||||||
|
|
||||||
noatime
|
noatime
|
||||||
|
@ -29,12 +29,12 @@ Bandwidth and IO limiting
|
|||||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
The ``ionice(1)`` may not be generally supported by all IO schedulers and
|
The :manref:`ionice(1)` may not be generally supported by all IO schedulers and
|
||||||
the options to :command:`btrfs scrub start` may not work as expected.
|
the options to :command:`btrfs scrub start` may not work as expected.
|
||||||
|
|
||||||
In the past when the `CFQ IO scheduler
|
In the past when the `CFQ IO scheduler
|
||||||
<https://en.wikipedia.org/wiki/Completely_fair_queueing>`__ was generally used
|
<https://en.wikipedia.org/wiki/Completely_fair_queueing>`__ was generally used
|
||||||
the ``ionice(1)`` syscalls set the priority to *idle* so the IO would not
|
the :manref:`ionice(1)` syscalls set the priority to *idle* so the IO would not
|
||||||
interfere with regular IO. Since the kernel 5.0 the CFQ is not available.
|
interfere with regular IO. Since the kernel 5.0 the CFQ is not available.
|
||||||
|
|
||||||
The IO scheduler known to support that is `BFQ
|
The IO scheduler known to support that is `BFQ
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
A swapfile, when active, is a file-backed swap area. It is supported since kernel 5.0.
|
A swapfile, when active, is a file-backed swap area. It is supported since kernel 5.0.
|
||||||
Use ``swapon(8)`` to activate it, until then (respectively again after deactivating it
|
Use :manref:`swapon(8)` to activate it, until then (respectively again after deactivating it
|
||||||
with ``swapoff(8)``) it's just a normal file (with NODATACOW set), for which the special
|
with :manref:`swapoff(8)`) it's just a normal file (with NODATACOW set), for which the special
|
||||||
restrictions for active swapfiles don't apply.
|
restrictions for active swapfiles don't apply.
|
||||||
|
|
||||||
There are some limitations of the implementation in BTRFS and Linux swap
|
There are some limitations of the implementation in BTRFS and Linux swap
|
||||||
|
@ -11,7 +11,7 @@ DESCRIPTION
|
|||||||
|
|
||||||
**fsck.btrfs** is a type of utility that should exist for any filesystem and is
|
**fsck.btrfs** is a type of utility that should exist for any filesystem and is
|
||||||
called during system setup when the corresponding ``/etc/fstab`` entries
|
called during system setup when the corresponding ``/etc/fstab`` entries
|
||||||
contain non-zero value for *fs_passno*, see ``fstab(5)`` for more.
|
contain non-zero value for *fs_passno*, see :manref:`fstab(5)` for more.
|
||||||
|
|
||||||
Traditional filesystems need to run their respective fsck utility in case the
|
Traditional filesystems need to run their respective fsck utility in case the
|
||||||
filesystem was not unmounted cleanly and the log needs to be replayed before
|
filesystem was not unmounted cleanly and the log needs to be replayed before
|
||||||
@ -48,5 +48,5 @@ SEE ALSO
|
|||||||
--------
|
--------
|
||||||
|
|
||||||
:doc:`btrfs`,
|
:doc:`btrfs`,
|
||||||
``fsck(8)``,
|
:manref:`fsck(8)`,
|
||||||
``fstab(5)``
|
:manref:`fstab(5)`
|
||||||
|
@ -616,4 +616,4 @@ SEE ALSO
|
|||||||
:doc:`btrfs-man5`,
|
:doc:`btrfs-man5`,
|
||||||
:doc:`btrfs`,
|
:doc:`btrfs`,
|
||||||
:doc:`btrfs-balance`,
|
:doc:`btrfs-balance`,
|
||||||
``wipefs(8)``
|
:manref:`wipefs(8)`
|
||||||
|
Loading…
Reference in New Issue
Block a user