clean-up "nolint" comments, remove unused ones

thaJeztah · thaJeztah · commit 29c7fc9520c5 · 2022-10-12T14:40:59.000+02:00
- fix "nolint" comments to be in the correct format (`//nolint:&lt;linters&gt;[,&lt;linter&gt;`
  no leading space, required colon (`:`) and linters.
- remove "nolint" comments for errcheck, which is disabled in our config.
- remove "nolint" comments that were no longer needed (nolintlint).
- where known, add a comment describing why a "nolint" was applied.

Signed-off-by: Sebastiaan van Stijn &lt;github@gone.nl&gt;
diff --git a/archive/tar_unix.go b/archive/tar_unix.go
@@ -58,8 +58,7 @@ func setHeaderForSpecialDevice(hdr *tar.Header, name string, fi os.FileInfo) err
 		return errors.New("unsupported stat type")
 	}
 
-	// Rdev is int32 on darwin/bsd, int64 on linux/solaris
-	rdev := uint64(s.Rdev) // nolint: unconvert
+	rdev := uint64(s.Rdev) //nolint:unconvert // rdev is int32 on darwin/bsd, int64 on linux/solaris
 
 	// Currently go does not fill in the major/minors
 	if s.Mode&syscall.S_IFBLK != 0 ||
diff --git a/contrib/fuzz/content_fuzzer.go b/contrib/fuzz/content_fuzzer.go
@@ -14,7 +14,7 @@
    limitations under the License.
 */
 
-// nolint: golint
+//nolint:golint
 package fuzz
 
 import (
diff --git a/integration/client/restart_monitor_test.go b/integration/client/restart_monitor_test.go
@@ -40,8 +40,7 @@ import (
 	exec "golang.org/x/sys/execabs"
 )
 
-// the following nolint is for shutting up gometalinter on non-linux.
-// nolint: unused
+//nolint:unused // Ignore on non-Linux
 func newDaemonWithConfig(t *testing.T, configTOML string) (*Client, *daemon, func()) {
 	if testing.Short() {
 		t.Skip()
diff --git a/oci/spec_opts.go b/oci/spec_opts.go
@@ -76,7 +76,6 @@ func setLinux(s *Spec) {
 	}
 }
 
-// nolint
 func setResources(s *Spec) {
 	if s.Linux != nil {
 		if s.Linux.Resources == nil {
@@ -85,7 +84,7 @@ func setResources(s *Spec) {
 	}
 }
 
-// nolint
+//nolint:unused // not used on all platforms
 func setResourcesWindows(s *Spec) {
 	if s.Windows != nil {
 		if s.Windows.Resources == nil {
@@ -94,7 +93,7 @@ func setResourcesWindows(s *Spec) {
 	}
 }
 
-// nolint
+//nolint:unused // not used on all platforms
 func setCPU(s *Spec) {
 	setResources(s)
 	if s.Linux != nil {
@@ -104,7 +103,7 @@ func setCPU(s *Spec) {
 	}
 }
 
-// nolint
+//nolint:deadcode,unused // not used on all platforms
 func setCPUWindows(s *Spec) {
 	setResourcesWindows(s)
 	if s.Windows != nil {
diff --git a/oci/spec_opts_linux_test.go b/oci/spec_opts_linux_test.go
@@ -31,7 +31,7 @@ import (
 	"golang.org/x/sys/unix"
 )
 
-// nolint:gosec
+//nolint:gosec
 func TestWithUserID(t *testing.T) {
 	t.Parallel()
 
@@ -86,7 +86,7 @@ guest:x:405:100:guest:/dev/null:/sbin/nologin
 	}
 }
 
-// nolint:gosec
+//nolint:gosec
 func TestWithUsername(t *testing.T) {
 	t.Parallel()
 
@@ -148,7 +148,7 @@ guest:x:405:100:guest:/dev/null:/sbin/nologin
 
 }
 
-// nolint:gosec
+//nolint:gosec
 func TestWithAdditionalGIDs(t *testing.T) {
 	t.Parallel()
 	expectedPasswd := `root:x:0:0:root:/root:/bin/ash
diff --git a/oci/spec_opts_nonlinux.go b/oci/spec_opts_nonlinux.go
@@ -28,27 +28,31 @@ import (
 
 // WithAllCurrentCapabilities propagates the effective capabilities of the caller process to the container process.
 // The capability set may differ from WithAllKnownCapabilities when running in a container.
-// nolint: deadcode, unused
+//
+//nolint:unused
 var WithAllCurrentCapabilities = func(ctx context.Context, client Client, c *containers.Container, s *Spec) error {
 	return WithCapabilities(nil)(ctx, client, c, s)
 }
 
 // WithAllKnownCapabilities sets all the known linux capabilities for the container process
-// nolint: deadcode, unused
+//
+//nolint:unused
 var WithAllKnownCapabilities = func(ctx context.Context, client Client, c *containers.Container, s *Spec) error {
 	return WithCapabilities(nil)(ctx, client, c, s)
 }
 
 // WithBlockIO sets the container's blkio parameters
-// nolint: deadcode, unused
+//
+//nolint:unused
 func WithBlockIO(blockio interface{}) SpecOpts {
 	return func(ctx context.Context, _ Client, c *containers.Container, s *Spec) error {
 		return errors.New("blkio not supported")
 	}
 }
 
 // WithCPUShares sets the container's cpu shares
-// nolint: deadcode, unused
+//
+//nolint:unused
 func WithCPUShares(shares uint64) SpecOpts {
 	return func(ctx context.Context, _ Client, c *containers.Container, s *Spec) error {
 		return nil
diff --git a/oci/utils_unix.go b/oci/utils_unix.go
@@ -127,7 +127,7 @@ func getDevices(path, containerPath string) ([]specs.LinuxDevice, error) {
 
 // TODO consider adding these consts to the OCI runtime-spec.
 const (
-	wildcardDevice = "a" //nolint // currently unused, but should be included when upstreaming to OCI runtime-spec.
+	wildcardDevice = "a" //nolint:deadcode,unused,varcheck // currently unused, but should be included when upstreaming to OCI runtime-spec.
 	blockDevice    = "b"
 	charDevice     = "c" // or "u"
 	fifoDevice     = "p"
@@ -148,7 +148,7 @@ func DeviceFromPath(path string) (*specs.LinuxDevice, error) {
 	}
 
 	var (
-		devNumber = uint64(stat.Rdev) //nolint: unconvert // the type is 32bit on mips.
+		devNumber = uint64(stat.Rdev) //nolint:unconvert // the type is 32bit on mips.
 		major     = unix.Major(devNumber)
 		minor     = unix.Minor(devNumber)
 	)
diff --git a/pkg/cri/opts/container.go b/pkg/cri/opts/container.go
@@ -83,7 +83,7 @@ func WithVolumes(volumeMounts map[string]string) containerd.NewContainerOpts {
 		// if it fails but not RM snapshot data.
 		// refer to https://github.com/containerd/containerd/pull/1868
 		// https://github.com/containerd/containerd/pull/1785
-		defer os.Remove(root) // nolint: errcheck
+		defer os.Remove(root)
 
 		unmounter := func(mountPath string) {
 			if uerr := mount.Unmount(mountPath, 0); uerr != nil {
diff --git a/pkg/cri/sbserver/service.go b/pkg/cri/sbserver/service.go
@@ -117,7 +117,7 @@ type criService struct {
 	baseOCISpecs map[string]*oci.Spec
 	// allCaps is the list of the capabilities.
 	// When nil, parsed from CapEff of /proc/self/status.
-	allCaps []string // nolint
+	allCaps []string //nolint:unused // Ignore on non-Linux
 	// unpackDuplicationSuppressor is used to make sure that there is only
 	// one in-flight fetch request or unpack handler for a given descriptor's
 	// or chain ID.
diff --git a/pkg/cri/server/service.go b/pkg/cri/server/service.go
@@ -113,7 +113,7 @@ type criService struct {
 	baseOCISpecs map[string]*oci.Spec
 	// allCaps is the list of the capabilities.
 	// When nil, parsed from CapEff of /proc/self/status.
-	allCaps []string // nolint
+	allCaps []string //nolint:unused // Ignore on non-Linux
 	// unpackDuplicationSuppressor is used to make sure that there is only
 	// one in-flight fetch request or unpack handler for a given descriptor's
 	// or chain ID.
diff --git a/pkg/cri/store/container/container.go b/pkg/cri/store/container/container.go
@@ -208,6 +208,6 @@ func (s *Store) Delete(id string) {
 		c.IO.Close()
 	}
 	s.labels.Release(c.ProcessLabel)
-	s.idIndex.Delete(id) // nolint: errcheck
+	s.idIndex.Delete(id)
 	delete(s.containers, id)
 }
diff --git a/pkg/cri/store/image/image.go b/pkg/cri/store/image/image.go
@@ -246,6 +246,6 @@ func (s *store) delete(id, ref string) {
 		return
 	}
 	// Remove the image if it is not referenced any more.
-	s.digestSet.Remove(digest) // nolint: errcheck
+	s.digestSet.Remove(digest)
 	delete(s.images, digest.String())
 }
diff --git a/pkg/cri/store/sandbox/sandbox.go b/pkg/cri/store/sandbox/sandbox.go
@@ -160,6 +160,6 @@ func (s *Store) Delete(id string) {
 		return
 	}
 	s.labels.Release(s.sandboxes[id].ProcessLabel)
-	s.idIndex.Delete(id) // nolint: errcheck
+	s.idIndex.Delete(id)
 	delete(s.sandboxes, id)
 }
diff --git a/pkg/netns/netns_linux.go b/pkg/netns/netns_linux.go
@@ -77,7 +77,7 @@ func newNS(baseDir string) (nsPath string, err error) {
 	defer func() {
 		// Ensure the mount point is cleaned up on errors
 		if err != nil {
-			os.RemoveAll(nsPath) // nolint: errcheck
+			os.RemoveAll(nsPath)
 		}
 	}()
 
@@ -107,7 +107,7 @@ func newNS(baseDir string) (nsPath string, err error) {
 		}
 
 		// Put this thread back to the orig ns, since it might get reused (pre go1.10)
-		defer origNS.Set() // nolint: errcheck
+		defer origNS.Set()
 
 		// bind mount the netns from the current thread (from /proc) onto the
 		// mount point. This causes the namespace to persist, even when there
@@ -214,6 +214,6 @@ func (n *NetNS) Do(f func(cnins.NetNS) error) error {
 	if err != nil {
 		return fmt.Errorf("get netns fd: %w", err)
 	}
-	defer ns.Close() // nolint: errcheck
+	defer ns.Close()
 	return ns.Do(f)
 }
diff --git a/pkg/progress/escape.go b/pkg/progress/escape.go
@@ -19,6 +19,6 @@ package progress
 const (
 	escape = "\x1b"
 	reset  = escape + "[0m"
-	red    = escape + "[31m" // nolint: deadcode, varcheck, unused
+	red    = escape + "[31m" //nolint:deadcode,unused,varcheck
 	green  = escape + "[32m"
 )
diff --git a/pkg/runtimeoptions/v1/doc.go b/pkg/runtimeoptions/v1/doc.go
@@ -14,4 +14,4 @@
    limitations under the License.
 */
 
-package runtimeoptions_v1 //nolint
+package runtimeoptions_v1 //nolint:revive // Ignore var-naming: don't use an underscore in package name (revive)

Original file line number	Diff line number	Diff line change
`@@ -58,8 +58,7 @@ func setHeaderForSpecialDevice(hdr *tar.Header, name string, fi os.FileInfo) err`
`58`	`58`	`return errors.New("unsupported stat type")`
`59`	`59`	`}`
`60`	`60`
`61`		`- // Rdev is int32 on darwin/bsd, int64 on linux/solaris`
`62`		`- rdev := uint64(s.Rdev) // nolint: unconvert`
	`61`	`+ rdev := uint64(s.Rdev) //nolint:unconvert // rdev is int32 on darwin/bsd, int64 on linux/solaris`
`63`	`62`
`64`	`63`	`// Currently go does not fill in the major/minors`
`65`	`64`	`if s.Mode&syscall.S_IFBLK != 0 \|\|`
Original file line number	Diff line number	Diff line change
`@@ -40,8 +40,7 @@ import (`
`40`	`40`	`exec "golang.org/x/sys/execabs"`
`41`	`41`	`)`
`42`	`42`
`43`		`-// the following nolint is for shutting up gometalinter on non-linux.`
`44`		`-// nolint: unused`
	`43`	`+//nolint:unused // Ignore on non-Linux`
`45`	`44`	`func newDaemonWithConfig(t testing.T, configTOML string) (Client, *daemon, func()) {`
`46`	`45`	`if testing.Short() {`
`47`	`46`	`t.Skip()`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,6 @@ func setLinux(s *Spec) {`
`76`	`76`	`}`
`77`	`77`	`}`
`78`	`78`
`79`		`-// nolint`
`80`	`79`	`func setResources(s *Spec) {`
`81`	`80`	`if s.Linux != nil {`
`82`	`81`	`if s.Linux.Resources == nil {`
`@@ -85,7 +84,7 @@ func setResources(s *Spec) {`
`85`	`84`	`}`
`86`	`85`	`}`
`87`	`86`
`88`		`-// nolint`
	`87`	`+//nolint:unused // not used on all platforms`
`89`	`88`	`func setResourcesWindows(s *Spec) {`
`90`	`89`	`if s.Windows != nil {`
`91`	`90`	`if s.Windows.Resources == nil {`
`@@ -94,7 +93,7 @@ func setResourcesWindows(s *Spec) {`
`94`	`93`	`}`
`95`	`94`	`}`
`96`	`95`
`97`		`-// nolint`
	`96`	`+//nolint:unused // not used on all platforms`
`98`	`97`	`func setCPU(s *Spec) {`
`99`	`98`	`setResources(s)`
`100`	`99`	`if s.Linux != nil {`
`@@ -104,7 +103,7 @@ func setCPU(s *Spec) {`
`104`	`103`	`}`
`105`	`104`	`}`
`106`	`105`
`107`		`-// nolint`
	`106`	`+//nolint:deadcode,unused // not used on all platforms`
`108`	`107`	`func setCPUWindows(s *Spec) {`
`109`	`108`	`setResourcesWindows(s)`
`110`	`109`	`if s.Windows != nil {`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ import (`
`31`	`31`	`"golang.org/x/sys/unix"`
`32`	`32`	`)`
`33`	`33`
`34`		`-// nolint:gosec`
	`34`	`+//nolint:gosec`
`35`	`35`	`func TestWithUserID(t *testing.T) {`
`36`	`36`	`t.Parallel()`
`37`	`37`
`@@ -86,7 +86,7 @@ guest:x:405:100:guest:/dev/null:/sbin/nologin`
`86`	`86`	`}`
`87`	`87`	`}`
`88`	`88`
`89`		`-// nolint:gosec`
	`89`	`+//nolint:gosec`
`90`	`90`	`func TestWithUsername(t *testing.T) {`
`91`	`91`	`t.Parallel()`
`92`	`92`
`@@ -148,7 +148,7 @@ guest:x:405:100:guest:/dev/null:/sbin/nologin`
`148`	`148`
`149`	`149`	`}`
`150`	`150`
`151`		`-// nolint:gosec`
	`151`	`+//nolint:gosec`
`152`	`152`	`func TestWithAdditionalGIDs(t *testing.T) {`
`153`	`153`	`t.Parallel()`
`154`	`154`	expectedPasswd := `root:x:0:0:root:/root:/bin/ash