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 /cmd/btrfs-rec | |
| parent | 1d52c7513c5bca088fd8e44ff56d07c44e806967 (diff) | |
tree-wide: Ensure that all packages have a doc comment
Diffstat (limited to 'cmd/btrfs-rec')
| -rw-r--r-- | cmd/btrfs-rec/inspect/dumptrees/print_tree.go | 2 | ||||
| -rw-r--r-- | cmd/btrfs-rec/inspect/mount/mount.go | 3 | ||||
| -rw-r--r-- | cmd/btrfs-rec/inspect/rebuildmappings/process.go | 3 | ||||
| -rw-r--r-- | cmd/btrfs-rec/inspect/rebuildtrees/rebuild.go | 4 |
4 files changed, 12 insertions, 0 deletions
diff --git a/cmd/btrfs-rec/inspect/dumptrees/print_tree.go b/cmd/btrfs-rec/inspect/dumptrees/print_tree.go index a0a3d46..a8c2adf 100644 --- a/cmd/btrfs-rec/inspect/dumptrees/print_tree.go +++ b/cmd/btrfs-rec/inspect/dumptrees/print_tree.go @@ -2,6 +2,8 @@ // // SPDX-License-Identifier: GPL-2.0-or-later +// Package dumptrees is the guts of the `btrfs-rec inspect dump-trees` +// command, which is a clone of `btrfs inspect-internal dump-tree`. package dumptrees import ( diff --git a/cmd/btrfs-rec/inspect/mount/mount.go b/cmd/btrfs-rec/inspect/mount/mount.go index da0bbb6..01d667f 100644 --- a/cmd/btrfs-rec/inspect/mount/mount.go +++ b/cmd/btrfs-rec/inspect/mount/mount.go @@ -2,6 +2,9 @@ // // SPDX-License-Identifier: GPL-2.0-or-later +// Package mount is the guts of the `btrfs-rec inspect mount` command, +// which mounts the filesystem read-only using FUSE; providing better +// tolerance of filesystem corruption than the in-kernel btrfs driver. package mount import ( diff --git a/cmd/btrfs-rec/inspect/rebuildmappings/process.go b/cmd/btrfs-rec/inspect/rebuildmappings/process.go index 7ce3748..a93b697 100644 --- a/cmd/btrfs-rec/inspect/rebuildmappings/process.go +++ b/cmd/btrfs-rec/inspect/rebuildmappings/process.go @@ -2,6 +2,9 @@ // // SPDX-License-Identifier: GPL-2.0-or-later +// Package rebuildmappings is the guts of the `btrfs-rec inspect +// rebuild-mappings` command, which rebuilds broken +// chunk/dev-extent/blockgroup trees. package rebuildmappings import ( diff --git a/cmd/btrfs-rec/inspect/rebuildtrees/rebuild.go b/cmd/btrfs-rec/inspect/rebuildtrees/rebuild.go index 708b504..364dfa0 100644 --- a/cmd/btrfs-rec/inspect/rebuildtrees/rebuild.go +++ b/cmd/btrfs-rec/inspect/rebuildtrees/rebuild.go @@ -2,6 +2,10 @@ // // SPDX-License-Identifier: GPL-2.0-or-later +// Package rebuildtrees is the guts of the `btrfs-rec inspect +// rebuild-trees` command, which rebuilds broken trees, but requires +// already-functioning chunk/dev-extent/blockgroup trees. +// chunk/dev-extent/blockgroup trees. package rebuildtrees import ( |