diff options
| author | Luke Shumaker <lukeshu@lukeshu.com> | 2023-03-16 18:38:11 -0400 |
|---|---|---|
| committer | Luke Shumaker <lukeshu@lukeshu.com> | 2023-03-17 02:51:41 -0400 |
| commit | 2ee7091933d2c07338dfb4699ce5665951b47afd (patch) | |
| tree | ae0dc5b84e68890c79d13e5694a38f1a59a64d07 /lib/btrfs | |
| parent | 1d52c7513c5bca088fd8e44ff56d07c44e806967 (diff) | |
tree-wide: Ensure that all packages have a doc comment
Diffstat (limited to 'lib/btrfs')
| -rw-r--r-- | lib/btrfs/btrfsitem/items.go | 2 | ||||
| -rw-r--r-- | lib/btrfs/btrfsprim/misc.go | 2 | ||||
| -rw-r--r-- | lib/btrfs/btrfssum/csum.go | 2 | ||||
| -rw-r--r-- | lib/btrfs/btrfstree/btree.go | 2 | ||||
| -rw-r--r-- | lib/btrfs/btrfsvol/lvm.go | 2 | ||||
| -rw-r--r-- | lib/btrfs/io1_pv.go | 2 |
6 files changed, 12 insertions, 0 deletions
diff --git a/lib/btrfs/btrfsitem/items.go b/lib/btrfs/btrfsitem/items.go index 49d421f..dd14fb8 100644 --- a/lib/btrfs/btrfsitem/items.go +++ b/lib/btrfs/btrfsitem/items.go @@ -2,6 +2,8 @@ // // SPDX-License-Identifier: GPL-2.0-or-later +// Package btrfsitem contains the definitions of all "items" that may +// be stored in a btrfs tree. package btrfsitem import ( 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 ( diff --git a/lib/btrfs/btrfssum/csum.go b/lib/btrfs/btrfssum/csum.go index 157371e..341eade 100644 --- a/lib/btrfs/btrfssum/csum.go +++ b/lib/btrfs/btrfssum/csum.go @@ -2,6 +2,8 @@ // // SPDX-License-Identifier: GPL-2.0-or-later +// Package btrfssum contains the checksum types and algorithms that +// btrfs uses. package btrfssum import ( diff --git a/lib/btrfs/btrfstree/btree.go b/lib/btrfs/btrfstree/btree.go index 4c10ffa..89d4f9d 100644 --- a/lib/btrfs/btrfstree/btree.go +++ b/lib/btrfs/btrfstree/btree.go @@ -2,6 +2,8 @@ // // SPDX-License-Identifier: GPL-2.0-or-later +// Package btrfstree contains core b+-tree implementation and +// interfaces. package btrfstree import ( diff --git a/lib/btrfs/btrfsvol/lvm.go b/lib/btrfs/btrfsvol/lvm.go index 51e2263..3834345 100644 --- a/lib/btrfs/btrfsvol/lvm.go +++ b/lib/btrfs/btrfsvol/lvm.go @@ -2,6 +2,8 @@ // // SPDX-License-Identifier: GPL-2.0-or-later +// Package btrfsvol contains core logical-volume-management layer of +// btrfs. package btrfsvol import ( diff --git a/lib/btrfs/io1_pv.go b/lib/btrfs/io1_pv.go index 72d33f5..3b13f73 100644 --- a/lib/btrfs/io1_pv.go +++ b/lib/btrfs/io1_pv.go @@ -2,6 +2,8 @@ // // SPDX-License-Identifier: GPL-2.0-or-later +// Package btrfs (and its sub-packages) are the core implementation of +// the btrfs filesystem. package btrfs import ( |