summaryrefslogtreecommitdiff
path: root/lib/btrfs/btrfsitem/item_qgrouplimit.go
diff options
context:
space:
mode:
authorLuke Shumaker <lukeshu@lukeshu.com>2023-03-17 01:46:40 -0400
committerLuke Shumaker <lukeshu@lukeshu.com>2023-03-17 02:51:43 -0400
commitc30c43f3690931218b88680b337d11a57a2fdc45 (patch)
treea682afa37eaa5a5cee8f8b7a587edc7a40372355 /lib/btrfs/btrfsitem/item_qgrouplimit.go
parente082cfb3b8f8226067078cc410e4997fd1cf14df (diff)
tree-wide: Ensure that all existing type doc comments follow the expected format
This is a notable improvement in the docs for btrfsitem.
Diffstat (limited to 'lib/btrfs/btrfsitem/item_qgrouplimit.go')
-rw-r--r--lib/btrfs/btrfsitem/item_qgrouplimit.go10
1 files changed, 8 insertions, 2 deletions
diff --git a/lib/btrfs/btrfsitem/item_qgrouplimit.go b/lib/btrfs/btrfsitem/item_qgrouplimit.go
index 47f7eca..e303b04 100644
--- a/lib/btrfs/btrfsitem/item_qgrouplimit.go
+++ b/lib/btrfs/btrfsitem/item_qgrouplimit.go
@@ -34,8 +34,14 @@ func (f QGroupLimitFlags) String() string {
return fmtutil.BitfieldString(f, qgroupLimitFlagNames, fmtutil.HexNone)
}
-// key.objectid = 0
-// key.offset = ID of the qgroup
+// QGroupLimit configures the maximum permissible amount of space that
+// a given qgroup can consume (tracked in a QGroupInfo item) on the
+// containing subvolume.
+//
+// Key:
+//
+// key.objectid = 0
+// key.offset = ID of the qgroup
type QGroupLimit struct { // trivial QGROUP_LIMIT=244
Flags QGroupLimitFlags `bin:"off=0, siz=8"`
MaxReferenced uint64 `bin:"off=8, siz=8"`