summaryrefslogtreecommitdiff
path: root/Documentation/btrfs-qgroup.txt
diff options
context:
space:
mode:
authorDavid Sterba <dsterba@suse.cz>2014-05-19 17:49:35 +0200
committerDavid Sterba <dsterba@suse.cz>2014-05-19 17:54:10 +0200
commita4197dfe24a1964f43734af126188c100885d88e (patch)
tree2777013a0acac0b7196684afb4faf7725b28886d /Documentation/btrfs-qgroup.txt
parentaaeae23458aa76a68f5e1b1fb8bf551b04f57f2e (diff)
btrfs-progs: doc: make all commands and subcommands bold
Italic format is used for parameters and values. also this makes the text visually separated, Signed-off-by: David Sterba <dsterba@suse.cz>
Diffstat (limited to 'Documentation/btrfs-qgroup.txt')
-rw-r--r--Documentation/btrfs-qgroup.txt24
1 files changed, 12 insertions, 12 deletions
diff --git a/Documentation/btrfs-qgroup.txt b/Documentation/btrfs-qgroup.txt
index 531febb3..12321926 100644
--- a/Documentation/btrfs-qgroup.txt
+++ b/Documentation/btrfs-qgroup.txt
@@ -7,13 +7,13 @@ btrfs-qgroup - control the quota group of a btrfs filesystem
SYNOPSIS
--------
-'btrfs qgroup' <subcommand> <args>
+*btrfs qgroup* <subcommand> <args>
DESCRIPTION
-----------
-'btrfs qgroup' is used to control quota group(qgroup) of a btrfs filesystem.
+*btrfs qgroup* is used to control quota group(qgroup) of a btrfs filesystem.
-NOTE: To use qgroup, it needs to enable quota first using 'btrfs quota'
+NOTE: To use qgroup, it needs to enable quota first using *btrfs quota*
command.
WARNING: Qgroup is not stable yet and will impact performance in current mainline
@@ -29,34 +29,34 @@ Also for snapshot, it consumes no quota initially since all its data
shares with its parent, so only modification in snapshot consumes quota.
Every subvolume/snapshot will have its own qgroup with id '0/<subvolume id>'
-upon creating, but can be later destroyed by 'btrfs qgroup destroy' command.
+upon creating, but can be later destroyed by *btrfs qgroup destroy* command.
NOTE: If the qgroup of a subvolume is destroyed, quota about the subvolume
will not be functional until qgroup '0/<subvolume id>' is created again.
SUBCOMMAND
----------
-'assign' <src> <dst> <path>::
+*assign* <src> <dst> <path>::
Assign qgroup <src> as the child qgroup of <dst> in the btrfs filesystem
identified by <path>.
-'remove' <src> <dst> <path>::
+*remove* <src> <dst> <path>::
Remove the relationship between child qgroup <src> and parent qgroup <dst> in
the btrfs filesystem identified by <path>.
-'create' <qgroupid> <path>::
+*create* <qgroupid> <path>::
Create a subvolume quota group.
+
For the '0/<subvolume id>' qgroup, a qgroup can be created even before the
subvolume created.
-'destroy' <qgroupid> <path>::
+*destroy* <qgroupid> <path>::
Destroy a qgroup.
+
If a qgroup is no isolated,which means it is a parent or child qgroup, it
can't be destroyed.
-'show' [options] <path>::
+*show* [options] <path>::
Show all qgroups in the btrfs filesystem identified by <path>.
+
`Options`
@@ -83,7 +83,7 @@ If no prefix is given, use ascending order by default.
+
If multiple <attr>s is given, use comma to separate.
-'limit' [options] <size>|none [<qgroupid>] <path>::
+*limit* [options] <size>|none [<qgroupid>] <path>::
Limit the size of a qgroup to <size> or no limit in the btrfs filesystem
identified by <path>.
+
@@ -92,12 +92,12 @@ is used if possible.
EXIT STATUS
-----------
-'btrfs qgroup' returns a zero exist status if it succeeds. Non zero is
+*btrfs qgroup* returns a zero exist status if it succeeds. Non zero is
returned in case of failure.
AVAILABILITY
------------
-'btrfs' is part of btrfs-progs. Btrfs filesystem is currently under heavy
+*btrfs* is part of btrfs-progs. Btrfs filesystem is currently under heavy
development,
and not suitable for any uses other than benchmarking and review.
Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for