From 99beb2ca024cf17982387505ac02aaaa37b65cf7 Mon Sep 17 00:00:00 2001
From: Kir Kolyshkin <kolyshkin@gmail.com>
Date: Fri, 13 Mar 2020 17:01:48 -0700
Subject: [PATCH] pkg/mount: deprecate

Add a deprecation/removal notice, pointing out to appropriate
replacement packages.

I was not sure if a package-level deprecation is enough, so
I also added notices around each block.

Note that `nolint:golint` annotations are left as is, otherwise
golint complains like this:

> pkg/mount/deprecated.go:45:1: comment on exported var `MergeTmpfsOptions` should be of the form `MergeTmpfsOptions ...` (golint)
> // Deprecated: use github.com/moby/sys/mount instead.
> ^

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
---
 pkg/mount/deprecated.go       | 10 +++++++++-
 pkg/mount/deprecated_linux.go |  1 +
 2 files changed, 10 insertions(+), 1 deletion(-)

diff --git a/pkg/mount/deprecated.go b/pkg/mount/deprecated.go
index d204d2f35d..27f2e3d4a0 100644
--- a/pkg/mount/deprecated.go
+++ b/pkg/mount/deprecated.go
@@ -1,18 +1,23 @@
 package mount // import "github.com/docker/docker/pkg/mount"
 
+// Deprecated: this package is not maintained and will be removed.
+// Use github.com/moby/sys/mount and github.com/moby/sys/mountinfo instead.
+
 import (
 	sysmount "github.com/moby/sys/mount"
 	"github.com/moby/sys/mountinfo"
 )
 
+// Deprecated: use github.com/moby/sys/mount instead.
 //nolint:golint
 var (
 	Mount            = sysmount.Mount
-	ForceMount       = sysmount.Mount // Deprecated: use Mount instead.
+	ForceMount       = sysmount.Mount // a deprecated synonym
 	Unmount          = sysmount.Unmount
 	RecursiveUnmount = sysmount.RecursiveUnmount
 )
 
+// Deprecated: use github.com/moby/sys/mount instead.
 //nolint:golint
 const (
 	RDONLY      = sysmount.RDONLY
@@ -39,15 +44,18 @@ const (
 	STRICTATIME = sysmount.STRICTATIME
 )
 
+// Deprecated: use github.com/moby/sys/mount instead.
 //nolint:golint
 var MergeTmpfsOptions = sysmount.MergeTmpfsOptions
 
+// Deprecated: use github.com/moby/sys/mountinfo instead.
 //nolint:golint
 type (
 	FilterFunc = mountinfo.FilterFunc
 	Info       = mountinfo.Info
 )
 
+// Deprecated: use github.com/moby/sys/mountinfo instead.
 //nolint:golint
 var (
 	Mounted   = mountinfo.Mounted
diff --git a/pkg/mount/deprecated_linux.go b/pkg/mount/deprecated_linux.go
index 8346d8a6ba..e4a4407a32 100644
--- a/pkg/mount/deprecated_linux.go
+++ b/pkg/mount/deprecated_linux.go
@@ -4,6 +4,7 @@ import (
 	sysmount "github.com/moby/sys/mount"
 )
 
+// Deprecated: use github.com/moby/sys/mount instead.
 //nolint:golint
 var (
 	MakeMount       = sysmount.MakeMount