From c30c43f3690931218b88680b337d11a57a2fdc45 Mon Sep 17 00:00:00 2001 From: Luke Shumaker Date: Fri, 17 Mar 2023 01:46:40 -0400 Subject: tree-wide: Ensure that all existing type doc comments follow the expected format This is a notable improvement in the docs for btrfsitem. --- lib/btrfs/btrfsitem/item_rootref.go | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'lib/btrfs/btrfsitem/item_rootref.go') diff --git a/lib/btrfs/btrfsitem/item_rootref.go b/lib/btrfs/btrfsitem/item_rootref.go index 4179890..e40b278 100644 --- a/lib/btrfs/btrfsitem/item_rootref.go +++ b/lib/btrfs/btrfsitem/item_rootref.go @@ -12,10 +12,12 @@ import ( "git.lukeshu.com/btrfs-progs-ng/lib/btrfs/btrfsprim" ) -// RootRefs link subvolumes parent→child for normal subvolumes and +// A RootRef links subvolumes parent→child for normal subvolumes and // base→snapshot for snapshot subvolumes. BACKREF items go the other // direction; child→parent and snapshot→base. // +// Key: +// // ROOT_REF | ROOT_BACKREF // key.objectid = ID of the parent subvolume | ID of the child subvolume // key.offset = ID of the child subvolume | ID of the parent subvolume -- cgit v1.2.3-2-g168b