From c30c43f3690931218b88680b337d11a57a2fdc45 Mon Sep 17 00:00:00 2001
From: Luke Shumaker <lukeshu@lukeshu.com>
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_freespacebitmap.go | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

(limited to 'lib/btrfs/btrfsitem/item_freespacebitmap.go')

diff --git a/lib/btrfs/btrfsitem/item_freespacebitmap.go b/lib/btrfs/btrfsitem/item_freespacebitmap.go
index ebc00e4..d70a2b5 100644
--- a/lib/btrfs/btrfsitem/item_freespacebitmap.go
+++ b/lib/btrfs/btrfsitem/item_freespacebitmap.go
@@ -4,8 +4,13 @@
 
 package btrfsitem
 
-// key.objectid = object ID of the FreeSpaceInfo (logical_addr)
-// key.offset = offset of the FreeSpaceInfo (size)
+// FreeSpaceBitmap is used in conjunction with FreeSpaceInfo for
+// highly-fragmented blockgroups.
+//
+// Key:
+//
+//	key.objectid = object ID of the FreeSpaceInfo (logical_addr)
+//	key.offset   = offset of the FreeSpaceInfo (size)
 type FreeSpaceBitmap struct { // complex FREE_SPACE_BITMAP=200
 	Bitmap []byte
 }
-- 
cgit v1.2.3-2-g168b