From 85dc0fb7d542614dc186e3d480526b9e26d0012a Mon Sep 17 00:00:00 2001 From: Kir Kolyshkin Date: Thu, 2 Apr 2020 11:29:42 -0700 Subject: [PATCH] pkg/mount: make standalone golint happy We do our CI via golangci-lint, which understands nolint: annotations. A standalone linter tool, golint, does not, and it insists on documenting these: > pkg/mount/deprecated.go:47:1: comment on exported var MergeTmpfsOptions should be of the form "MergeTmpfsOptions ..." > pkg/mount/deprecated.go:51:1: comment on exported type FilterFunc should be of the form "FilterFunc ..." (with optional leading article) > pkg/mount/deprecated.go:51:1: comment on exported type Info should be of the form "Info ..." (with optional leading article) For `MergeTmpfsOptions`, the workaround is to put it inside a `var ( ... )` block. For the other two warnings, we have to provide the "actual" documentation (or something that looks like it). Signed-off-by: Kir Kolyshkin --- pkg/mount/deprecated.go | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/pkg/mount/deprecated.go b/pkg/mount/deprecated.go index 27f2e3d4a0..86ef303c85 100644 --- a/pkg/mount/deprecated.go +++ b/pkg/mount/deprecated.go @@ -46,13 +46,18 @@ const ( // Deprecated: use github.com/moby/sys/mount instead. //nolint:golint -var MergeTmpfsOptions = sysmount.MergeTmpfsOptions +var ( + MergeTmpfsOptions = sysmount.MergeTmpfsOptions +) -// Deprecated: use github.com/moby/sys/mountinfo instead. //nolint:golint type ( + // FilterFunc is a type. + // Deprecated: use github.com/moby/sys/mountinfo instead. FilterFunc = mountinfo.FilterFunc - Info = mountinfo.Info + // Info is a type. + // Deprecated: use github.com/moby/sys/mountinfo instead. + Info = mountinfo.Info // Info is deprecated ) // Deprecated: use github.com/moby/sys/mountinfo instead.