Fix: Add package comments and update linter config

.golangci.yml

@@ -37,9 +37,6 @@ issues:
     - linters:
       - govet
       text: "copylocks"
-    - linters:
-      - revive
-      text: package-comments
     - linters:
       - staticcheck
       text: "Do not rely on the global seed"

client/client.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package client provides utilities for clients of firecracker-containerd.
 package client
 
 import "github.com/firecracker-microvm/firecracker-containerd/internal/bundle"

docker-credential-mmds/mmds/client.go

@@ -10,6 +10,8 @@
 // on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
+
+// Package mmds provides a docker credential helper backed by Firecracker's MMDS.
 package mmds
 
 import (

docker-credential-mmds/mmds/helper.go

@@ -10,6 +10,8 @@
 // on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
+
+// Package mmds provides a docker credential helper backed by Firecracker's MMDS.
 package mmds
 
 import (

eventbridge/eventbridge.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package eventbridge provides utilities for bridging containerd event streams.
 package eventbridge
 
 import (

firecracker-control/client/client.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package client provides a client for the firecracker-control service.
 package client
 
 import (

firecracker-control/common.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package service implements the firecracker-control service.
 package service
 
 const (

firecracker-control/local.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package service implements the firecracker-control service.
 package service
 
 import (

firecracker-control/service.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package service implements the firecracker-control service.
 package service
 
 import (

internal/bundle/bundle.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package bundle provides utilities for working with container bundles.
 package bundle
 
 import (

internal/common.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package internal contains internal utilities.
 package internal
 
 import (

internal/common_test.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package internal contains internal utilities.
 package internal
 
 import (

internal/cpu_template.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package internal contains internal utilities.
 package internal
 
 import (

internal/cpu_template_test.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package internal contains internal utilities.
 package internal
 
 import (

internal/debug/debug.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package debug provides utilities for handling multi-level logging.
 package debug
 
 import (

internal/debug/error.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package debug provides utilities for handling multi-level logging.
 package debug
 
 import (

internal/event/exchange.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package event provides event-related utilities.
 package event
 
 import (

internal/fsutil.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package internal contains internal utilities.
 package internal
 
 import (

internal/integtest/config.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package integtest provides integration testing utilities.
 package integtest
 
 import (

internal/integtest/containerd.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package integtest provides integration testing utilities.
 package integtest
 
 import (

internal/integtest/firecracker.go

@@ -11,9 +11,12 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package integtest provides integration testing utilities.
 package integtest
 
-import "github.com/firecracker-microvm/firecracker-containerd/firecracker-control/client"
+import (
+	"github.com/firecracker-microvm/firecracker-containerd/firecracker-control/client"
+)
 
 // NewFCControlClient returns a Firecracker control client for the given socket.
 func NewFCControlClient(socket string) (*client.Client, error) {

internal/integtest/network.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package integtest provides integration testing utilities.
 package integtest
 
 import (

internal/integtest/prepare.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package integtest provides integration testing utilities.
 package integtest
 
 import (

internal/integtest/runtime.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package integtest provides integration testing utilities.
 package integtest
 
 import (

internal/integtest/shim.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package integtest provides integration testing utilities.
 package integtest
 
 import "os"

internal/network_test_utils.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package internal contains internal utilities.
 package internal
 
 import (

internal/psutil.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package internal contains internal utilities.
 package internal
 
 import (

internal/shim/shim.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package shim provides firecracker-containerd specific shim utilities.
 package shim
 
 import (

internal/testutils.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package internal contains internal utilities.
 package internal
 
 import (

internal/vm/agent.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package vm provides utilities for managing the VM.
 package vm
 
 import (

internal/vm/fifo.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package vm provides utilities for managing the VM.
 package vm
 
 import (

internal/vm/mount.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package vm provides utilities for managing the VM.
 package vm
 
 import (

internal/vm/oci.go

@@ -24,6 +24,7 @@
    limitations under the License.
 */
 
+// Package vm provides utilities for managing the VM.
 package vm
 
 import (

internal/vm/task.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package vm provides utilities for managing the VM.
 package vm
 
 import (

internal/vm/task_test.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package vm provides utilities for managing the VM.
 package vm
 
 import (

internal/vm/vsock.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package vm provides utilities for managing the VM.
 package vm
 
 import (

runtime/cpuset/cpuset_builder.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package cpuset provides a builder for creating cpuset configurations.
 package cpuset
 
 import (

runtime/firecrackeroci/annotation.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package firecrackeroci provides OCI utilities specific to firecracker-containerd.
 package firecrackeroci
 
 import (

runtime/firecrackeroci/network.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package firecrackeroci provides OCI utilities specific to firecracker-containerd.
 package firecrackeroci
 
 import (

runtime/firecrackeroci/vm.go

@@ -11,19 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
-/*
-   Copyright The containerd Authors.
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-       http://www.apache.org/licenses/LICENSE-2.0
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
-*/
-
+// Package firecrackeroci provides OCI utilities specific to firecracker-containerd.
 package firecrackeroci
 
 import (

runtime/vm/mount.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package vm provides utilities for managing the VM.
 package vm
 
 import (

snapshotter/app/service.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package app provides the entrypoint for the demux snapshotter.
 package app
 
 import (

snapshotter/config/config.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package config defines the configuration for the demux snapshotter.
 package config
 
 import (

snapshotter/internal/integtest/stargz/fs/config/config.go

@@ -38,6 +38,7 @@
    license that can be found in the NOTICE.md file.
 */
 
+// Package config provides constants for stargz snapshotter integration tests.
 package config
 
 const (

snapshotter/internal/mount/collection.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package mount provides utilities for mount points.
 package mount
 
 import "github.com/containerd/containerd/mount"

volume/guest_image.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package volume provides functionality for volume management.
 package volume
 
 import (

volume/image.go

@@ -11,6 +11,7 @@
 // express or implied. See the License for the specific language governing
 // permissions and limitations under the License.
 
+// Package volume provides functionality for volume management.
 package volume
 
 import (