kotovalexarian-likes-github/moby--moby
1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
Code Releases Activity

pkg/mount: make standalone golint happy

Browse source 
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 <kolyshkin@gmail.com>
This commit is contained in:
Kir Kolyshkin 2020-04-02 11:29:42 -07:00
parent 99beb2ca02
commit 85dc0fb7d5
1 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
pkg/mount/deprecated.go
View file

@ -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.