summaryrefslogtreecommitdiff
path: root/lib/btrfs/btrfsitem/item_qgroupstatus.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_qgroupstatus.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_qgroupstatus.go')
-rw-r--r--lib/btrfs/btrfsitem/item_qgroupstatus.go10
1 files changed, 8 insertions, 2 deletions
diff --git a/lib/btrfs/btrfsitem/item_qgroupstatus.go b/lib/btrfs/btrfsitem/item_qgroupstatus.go
index 346c913..b140371 100644
--- a/lib/btrfs/btrfsitem/item_qgroupstatus.go
+++ b/lib/btrfs/btrfsitem/item_qgroupstatus.go
@@ -32,8 +32,14 @@ func (f QGroupStatusFlags) String() string {
const QGroupStatusVersion uint64 = 1
-// key.objectid = 0
-// key.offset = 0
+// A QGroupStatus holds the qgroup state of a subvolume (I think that
+// implies that the QGroupStatus goes in the subvolume tree that it is
+// describing?).
+//
+// Key:
+//
+// key.objectid = 0
+// key.offset = 0
type QGroupStatus struct { // trivial QGROUP_STATUS=240
Version uint64 `bin:"off=0, siz=8"`
Generation btrfsprim.Generation `bin:"off=8, siz=8"`