pkg/archive: deprecate CanonicalTarNameForPath

thaJeztah · thaJeztah · commit 92b8d93f4729 · 2024-06-16T16:56:25.000+02:00
Commit d597584 changed this function to be a wrapper for `filepath.ToSlash`. It was used in the CLI for the classic builder, but is no longer used in our codebase. However, there may still be some consumers that copied the CLI code for the classic builder that didn't synchronise their implementation yet, so let's deprecate this function to give them a warning that they should no longer use this. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
diff --git a/pkg/archive/archive.go b/pkg/archive/archive.go
@@ -541,8 +541,10 @@ func newTarAppender(idMapping idtools.IdentityMapping, writer io.Writer, chownOp
 }
 
 // CanonicalTarNameForPath canonicalizes relativePath to a POSIX-style path using
-// forward slashes. It is an alias for filepath.ToSlash, which is a no-op on
+// forward slashes. It is an alias for [filepath.ToSlash], which is a no-op on
 // Linux and Unix.
+//
+// Deprecated: use [filepath.ToSlash]. This function will be removed in the next release.
 func CanonicalTarNameForPath(relativePath string) string {
 	return filepath.ToSlash(relativePath)
 }

Original file line number	Diff line number	Diff line change
`@@ -541,8 +541,10 @@ func newTarAppender(idMapping idtools.IdentityMapping, writer io.Writer, chownOp`
`541`	`541`	`}`
`542`	`542`
`543`	`543`	`// CanonicalTarNameForPath canonicalizes relativePath to a POSIX-style path using`
`544`		`-// forward slashes. It is an alias for filepath.ToSlash, which is a no-op on`
	`544`	`+// forward slashes. It is an alias for [filepath.ToSlash], which is a no-op on`
`545`	`545`	`// Linux and Unix.`
	`546`	`+//`
	`547`	`+// Deprecated: use [filepath.ToSlash]. This function will be removed in the next release.`
`546`	`548`	`func CanonicalTarNameForPath(relativePath string) string {`
`547`	`549`	`return filepath.ToSlash(relativePath)`
`548`	`550`	`}`