From 2ee7091933d2c07338dfb4699ce5665951b47afd Mon Sep 17 00:00:00 2001 From: Luke Shumaker Date: Thu, 16 Mar 2023 18:38:11 -0400 Subject: tree-wide: Ensure that all packages have a doc comment --- lib/btrfs/btrfsprim/misc.go | 2 ++ 1 file changed, 2 insertions(+) (limited to 'lib/btrfs/btrfsprim') diff --git a/lib/btrfs/btrfsprim/misc.go b/lib/btrfs/btrfsprim/misc.go index 38290d6..43ba306 100644 --- a/lib/btrfs/btrfsprim/misc.go +++ b/lib/btrfs/btrfsprim/misc.go @@ -2,6 +2,8 @@ // // SPDX-License-Identifier: GPL-2.0-or-later +// Package btrfsprim contains primitive btrfs datatypes, that all +// other btrfs sub-packages may make use of. package btrfsprim import ( -- cgit v1.2.3-2-g168b From e082cfb3b8f8226067078cc410e4997fd1cf14df Mon Sep 17 00:00:00 2001 From: Luke Shumaker Date: Thu, 16 Mar 2023 18:45:45 -0400 Subject: tree-wide: Ensure that all existing method doc comments follow the expected format --- lib/btrfs/btrfsprim/key.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'lib/btrfs/btrfsprim') diff --git a/lib/btrfs/btrfsprim/key.go b/lib/btrfs/btrfsprim/key.go index b07cc8c..2930782 100644 --- a/lib/btrfs/btrfsprim/key.go +++ b/lib/btrfs/btrfsprim/key.go @@ -21,7 +21,10 @@ type Key struct { const MaxOffset uint64 = math.MaxUint64 -// mimics print-tree.c:btrfs_print_key() +// Format returns a human-friendly string representation of the Key, +// according to which tree it appears in. +// +// The formatting of the key mimics print-tree.c:btrfs_print_key(). func (key Key) Format(tree ObjID) string { switch tree { case UUID_TREE_OBJECTID: -- cgit v1.2.3-2-g168b From 1ea26f04701fa66e36b058f3efb3a6c7059cdc5c Mon Sep 17 00:00:00 2001 From: Luke Shumaker Date: Fri, 17 Mar 2023 02:28:54 -0400 Subject: tree-wide: Turn on all revive linters (with exceptions) --- lib/btrfs/btrfsprim/key.go | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) (limited to 'lib/btrfs/btrfsprim') diff --git a/lib/btrfs/btrfsprim/key.go b/lib/btrfs/btrfsprim/key.go index 2930782..5580c52 100644 --- a/lib/btrfs/btrfsprim/key.go +++ b/lib/btrfs/btrfsprim/key.go @@ -42,12 +42,11 @@ func (key Key) Format(tree ObjID) string { return fmt.Sprintf("(%v %v -1)", key.ObjectID.Format(tree), key.ItemType) - } else { - return fmt.Sprintf("(%v %v %v)", - key.ObjectID.Format(tree), - key.ItemType, - key.Offset) } + return fmt.Sprintf("(%v %v %v)", + key.ObjectID.Format(tree), + key.ItemType, + key.Offset) } } -- cgit v1.2.3-2-g168b