pkg/containerfs: cleanup GoDoc, and make Windows a proper wrapper

thaJeztah · thaJeztah · commit a3e6ce95c4aa · 2024-06-30T19:13:16.000+02:00
- Improve some GoDoc to use docs links
- Change the Windows stub to an actual wrapper function, as we don't
  want it to be updateable, and it currently shows as "variable" on
  pkg.go.dev, which is confusing.
- Remove "import" comments in preparation of moving this package

Signed-off-by: Sebastiaan van Stijn &lt;github@gone.nl&gt;
diff --git a/pkg/containerfs/rm.go b/pkg/containerfs/rm.go
@@ -1,6 +1,6 @@
 //go:build !darwin && !windows
 
-package containerfs // import "github.com/docker/docker/pkg/containerfs"
+package containerfs
 
 import (
 	"os"
@@ -11,18 +11,18 @@ import (
 	"github.com/pkg/errors"
 )
 
-// EnsureRemoveAll wraps `os.RemoveAll` to check for specific errors that can
+// EnsureRemoveAll wraps [os.RemoveAll] to check for specific errors that can
 // often be remedied.
-// Only use `EnsureRemoveAll` if you really want to make every effort to remove
+// Only use [EnsureRemoveAll] if you really want to make every effort to remove
 // a directory.
 //
-// Because of the way `os.Remove` (and by extension `os.RemoveAll`) works, there
+// Because of the way [os.Remove] (and by extension [os.RemoveAll]) works, there
 // can be a race between reading directory entries and then actually attempting
 // to remove everything in the directory.
 // These types of errors do not need to be returned since it's ok for the dir to
 // be gone we can just retry the remove operation.
 //
-// This should not return a `os.ErrNotExist` kind of error under any circumstances
+// This should not return a [os.ErrNotExist] kind of error under any circumstances.
 func EnsureRemoveAll(dir string) error {
 	notExistErr := make(map[string]bool)
 
diff --git a/pkg/containerfs/rm_nodarwin_test.go b/pkg/containerfs/rm_nodarwin_test.go
@@ -1,6 +1,6 @@
 //go:build !darwin
 
-package containerfs // import "github.com/docker/docker/pkg/containerfs"
+package containerfs
 
 import (
 	"os"
diff --git a/pkg/containerfs/rm_test.go b/pkg/containerfs/rm_test.go
@@ -1,6 +1,6 @@
 //go:build !darwin && !windows
 
-package containerfs // import "github.com/docker/docker/pkg/containerfs"
+package containerfs
 
 import (
 	"os"
diff --git a/pkg/containerfs/rm_windows.go b/pkg/containerfs/rm_windows.go
@@ -1,6 +1,8 @@
-package containerfs // import "github.com/docker/docker/pkg/containerfs"
+package containerfs
 
 import "os"
 
-// EnsureRemoveAll is an alias to os.RemoveAll on Windows
-var EnsureRemoveAll = os.RemoveAll
+// EnsureRemoveAll is an alias to [os.RemoveAll] on Windows.
+func EnsureRemoveAll(path string) error {
+	return os.RemoveAll(path)
+}
