mirror of
https://github.com/kdave/btrfs-progs
synced 2024-12-13 01:46:14 +00:00
c59fc1d89c
Document the new options in btrfs quota and mkfs.btrfs. Also, add a section to the long form qgroups document about squota. Signed-off-by: Boris Burkov <boris@bur.io> Signed-off-by: David Sterba <dsterba@suse.com>
91 lines
2.6 KiB
ReStructuredText
91 lines
2.6 KiB
ReStructuredText
btrfs-quota(8)
|
|
==============
|
|
|
|
SYNOPSIS
|
|
--------
|
|
|
|
**btrfs quota** <subcommand> <args>
|
|
|
|
DESCRIPTION
|
|
-----------
|
|
|
|
The commands under :command:`btrfs quota` are used to affect the global status of quotas
|
|
of a btrfs filesystem. The quota groups (qgroups) are managed by the subcommand
|
|
:doc:`btrfs-qgroup`.
|
|
|
|
.. note::
|
|
Qgroups are different than the traditional user quotas and designed
|
|
to track shared and exclusive data per-subvolume. Please refer to the section
|
|
:ref:`HIERARCHICAL QUOTA GROUP CONCEPTS<man-quota-hierarchical-quota-group-concepts>`
|
|
for a detailed description.
|
|
|
|
PERFORMANCE IMPLICATIONS
|
|
^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
When quotas are activated, they affect all extent processing, which takes a
|
|
performance hit. Activation of qgroups is not recommended unless the user
|
|
intends to actually use them.
|
|
|
|
STABILITY STATUS
|
|
^^^^^^^^^^^^^^^^
|
|
|
|
The qgroup implementation has turned out to be quite difficult as it affects
|
|
the core of the filesystem operation. Qgroup users have hit various corner cases
|
|
over time, such as incorrect accounting or system instability. The situation is
|
|
gradually improving and issues found and fixed.
|
|
|
|
.. _man-quota-hierarchical-quota-group-concepts:
|
|
|
|
HIERARCHICAL QUOTA GROUP CONCEPTS
|
|
---------------------------------
|
|
|
|
.. include:: ch-quota-intro.rst
|
|
|
|
SUBCOMMAND
|
|
----------
|
|
|
|
disable <path>
|
|
Disable subvolume quota support for a filesystem.
|
|
|
|
enable [options] <path>
|
|
Enable subvolume quota support for a filesystem. At this point it's
|
|
possible the two modes of accounting. The *full* means that extent
|
|
ownership by subvolumes will be tracked all the time, *simple* will
|
|
account everything to the first owner. See the section for more details.
|
|
|
|
``Options``
|
|
|
|
-s|--simple
|
|
use simple quotas (squotas) instead of full qgroup accounting
|
|
|
|
rescan [options] <path>
|
|
Trash all qgroup numbers and scan the metadata again with the current config.
|
|
|
|
``Options``
|
|
|
|
-s|--status
|
|
show status of a running rescan operation.
|
|
-w|--wait
|
|
start rescan and wait for it to finish (can be already in progress)
|
|
-W|--wait-norescan
|
|
wait for rescan to finish without starting it
|
|
|
|
EXIT STATUS
|
|
-----------
|
|
|
|
**btrfs quota** returns a zero exit status if it succeeds. Non zero is
|
|
returned in case of failure.
|
|
|
|
AVAILABILITY
|
|
------------
|
|
|
|
**btrfs** is part of btrfs-progs. Please refer to the documentation at
|
|
`https://btrfs.readthedocs.io <https://btrfs.readthedocs.io>`_.
|
|
|
|
SEE ALSO
|
|
--------
|
|
|
|
:doc:`btrfs-qgroup`,
|
|
:doc:`btrfs-subvolume`,
|
|
:doc:`mkfs.btrfs`
|