diff options
| author | Luke Shumaker <lukeshu@lukeshu.com> | 2023-03-17 01:46:40 -0400 |
|---|---|---|
| committer | Luke Shumaker <lukeshu@lukeshu.com> | 2023-03-17 02:51:43 -0400 |
| commit | c30c43f3690931218b88680b337d11a57a2fdc45 (patch) | |
| tree | a682afa37eaa5a5cee8f8b7a587edc7a40372355 /lib/btrfs/btrfsitem/item_extentcsum.go | |
| parent | e082cfb3b8f8226067078cc410e4997fd1cf14df (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_extentcsum.go')
| -rw-r--r-- | lib/btrfs/btrfsitem/item_extentcsum.go | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/lib/btrfs/btrfsitem/item_extentcsum.go b/lib/btrfs/btrfsitem/item_extentcsum.go index dfa166d..a963c16 100644 --- a/lib/btrfs/btrfsitem/item_extentcsum.go +++ b/lib/btrfs/btrfsitem/item_extentcsum.go @@ -11,8 +11,12 @@ import ( "git.lukeshu.com/btrfs-progs-ng/lib/btrfs/btrfsvol" ) -// key.objectid = BTRFS_EXTENT_CSUM_OBJECTID -// key.offset = laddr of checksummed region +// An ExtentCSum checksums regions of the logical address space. +// +// Key: +// +// key.objectid = BTRFS_EXTENT_CSUM_OBJECTID +// key.offset = laddr of checksummed region type ExtentCSum struct { // trivial EXTENT_CSUM=128 // Checksum of each sector starting at key.offset btrfssum.SumRun[btrfsvol.LogicalAddr] |