pkg/homedir: deprecate GetShortcutString() utility

thaJeztah · thaJeztah · commit ddd9665289fa · 2023-06-26T14:45:21.000+02:00
This function was last used in the pkg/mflag package, which was removed in 14712f9, and is no longer used in libnetwork code since moby/libnetwork@e6de8ae Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
diff --git a/pkg/homedir/homedir.go b/pkg/homedir/homedir.go
@@ -35,6 +35,8 @@ func Get() string {
 
 // GetShortcutString returns the string that is shortcut to user's home directory
 // in the native shell of the platform running on.
+//
+// Deprecated: this function is no longer used, and will be removed in the next release.
 func GetShortcutString() string {
 	return homeShortCut
 }
diff --git a/pkg/homedir/homedir_test.go b/pkg/homedir/homedir_test.go
@@ -17,7 +17,7 @@ func TestGet(t *testing.T) {
 }
 
 func TestGetShortcutString(t *testing.T) {
-	shortcut := GetShortcutString()
+	shortcut := GetShortcutString() //nolint:staticcheck // ignore SA1019 (GetShortcutString is deprecated)
 	if shortcut == "" {
 		t.Fatal("returned shortcut string is empty")
 	}

Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,8 @@ func Get() string {`
`35`	`35`
`36`	`36`	`// GetShortcutString returns the string that is shortcut to user's home directory`
`37`	`37`	`// in the native shell of the platform running on.`
	`38`	`+//`
	`39`	`+// Deprecated: this function is no longer used, and will be removed in the next release.`
`38`	`40`	`func GetShortcutString() string {`
`39`	`41`	`return homeShortCut`
`40`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ func TestGet(t *testing.T) {`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`func TestGetShortcutString(t *testing.T) {`
`20`		`- shortcut := GetShortcutString()`
	`20`	`+ shortcut := GetShortcutString() //nolint:staticcheck // ignore SA1019 (GetShortcutString is deprecated)`
`21`	`21`	`if shortcut == "" {`
`22`	`22`	`t.Fatal("returned shortcut string is empty")`
`23`	`23`	`}`