pkg/homedir: deprecate Key() utility

thaJeztah · thaJeztah · commit 3c1de2e667f4 · 2023-06-26T14:46:03.000+02:00
This utility was only used in tests, and internally, and no longer
used since we switch to using os.UserHomeDir() from stdlib.

Signed-off-by: Sebastiaan van Stijn &lt;github@gone.nl&gt;
diff --git a/pkg/homedir/homedir.go b/pkg/homedir/homedir.go
@@ -8,6 +8,8 @@ import (
 
 // Key returns the env var name for the user's home dir based on
 // the platform being run on.
+//
+// Deprecated: this function is no longer used, and will be removed in the next release.
 func Key() string {
 	return envKeyName
 }

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,8 @@ import (`
`8`	`8`
`9`	`9`	`// Key returns the env var name for the user's home dir based on`
`10`	`10`	`// the platform being run on.`
	`11`	`+//`
	`12`	`+// Deprecated: this function is no longer used, and will be removed in the next release.`
`11`	`13`	`func Key() string {`
`12`	`14`	`return envKeyName`
`13`	`15`	`}`