update docs

Signed-off-by: Lixia (Sylvia) Lei <[email protected]>

Author: Wwwsylvia

file_store.go

@@ -24,31 +24,35 @@ import (
 //
 // Reference: https://docs.docker.com/engine/reference/commandline/cli/#docker-cli-configuration-file-configjson-properties
 //
-// Deprecated: This type is deprecated.
-// The same functionality is now provided by oras-go.
+// Deprecated: This type is now simply [credentials.FileStore] of oras-go.
+//
+// [credentials.FileStore]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials#FileStore
 type FileStore = orascreds.FileStore
 
 var (
 	// ErrPlaintextPutDisabled is returned by Put() when DisablePut is set
 	// to true.
 	//
-	// Deprecated: This type is deprecated.
-	// The same functionality is now provided by oras-go.
+	// Deprecated: This type is now simply [credentials.ErrPlaintextPutDisabled] of oras-go.
+	//
+	// [credentials.ErrPlaintextPutDisabled]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials#ErrPlaintextPutDisabled
 	ErrPlaintextPutDisabled = orascreds.ErrPlaintextPutDisabled
 	// ErrBadCredentialFormat is returned by Put() when the credential format
 	// is bad.
 	//
-	// Deprecated: This type is deprecated.
-	// The same functionality is now provided by oras-go.
+	// Deprecated: This type is now simply [credentials.ErrBadCredentialFormat] of oras-go.
+	//
+	// [credentials.ErrBadCredentialFormat]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials#ErrBadCredentialFormat
 	ErrBadCredentialFormat = orascreds.ErrBadCredentialFormat
 )
 
 // NewFileStore creates a new file credentials store.
 //
 // Reference: https://docs.docker.com/engine/reference/commandline/cli/#docker-cli-configuration-file-configjson-properties
 //
-// Deprecated: This function is deprecated.
-// The same functionality is now provided by oras-go.
+// Deprecated: This funciton now simply calls [credentials.NewFileStore] of oras-go.
+//
+// [credentials.NewFileStore]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials#NewFileStore
 func NewFileStore(configPath string) (*FileStore, error) {
 	return orascreds.NewFileStore(configPath)
 }

memory_store.go

@@ -21,8 +21,9 @@ import (
 
 // NewMemoryStore creates a new in-memory credentials store.
 //
-// Deprecated: This function is deprecated.
-// The same functionality is now provided by oras-go.
+// Deprecated: This funciton now simply calls [credentials.NewMemoryStore] of oras-go.
+//
+// [credentials.NewMemoryStore]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials#NewMemoryStore
 func NewMemoryStore() Store {
 	return orascreds.NewMemoryStore()
 }

native_store.go

@@ -29,8 +29,9 @@ import (
 // Reference:
 //   - https://docs.docker.com/engine/reference/commandline/login#credentials-store
 //
-// Deprecated: This function is deprecated.
-// The same functionality is now provided by oras-go.
+// Deprecated: This funciton now simply calls [credentials.NewNativeStore] of oras-go.
+//
+// [credentials.NewNativeStore]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials#NewNativeStore
 func NewNativeStore(helperSuffix string) Store {
 	return orascreds.NewNativeStore(helperSuffix)
 }
@@ -45,8 +46,9 @@ func NewNativeStore(helperSuffix string) Store {
 // Reference:
 //   - https://docs.docker.com/engine/reference/commandline/login/#credentials-store
 //
-// Deprecated: This function is deprecated.
-// The same functionality is now provided by oras-go.
+// Deprecated: This funciton now simply calls [credentials.NewDefaultNativeStore] of oras-go.
+//
+// [credentials.NewDefaultNativeStore]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials#NewDefaultNativeStore
 func NewDefaultNativeStore() (Store, bool) {
 	return orascreds.NewDefaultNativeStore()
 }

registry.go

@@ -26,33 +26,37 @@ import (
 // ErrClientTypeUnsupported is thrown by Login() when the registry's client type
 // is not supported.
 //
-// Deprecated: This type is deprecated.
-// The same functionality is now provided by oras-go.
+// Deprecated: This type is now simply [credentials.ErrClientTypeUnsupported] of oras-go.
+//
+// [credentials.ErrClientTypeUnsupported]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials#ErrClientTypeUnsupported
 var ErrClientTypeUnsupported = orascreds.ErrClientTypeUnsupported
 
 // Login provides the login functionality with the given credentials. The target
 // registry's client should be nil or of type *auth.Client. Login uses
 // a client local to the function and will not modify the original client of
 // the registry.
 //
-// Deprecated: This function is deprecated.
-// The same functionality is now provided by oras-go.
+// Deprecated: This funciton now simply calls [credentials.Login] of oras-go.
+//
+// [credentials.Login]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials#Login
 func Login(ctx context.Context, store Store, reg *remote.Registry, cred auth.Credential) error {
 	return orascreds.Login(ctx, store, reg, cred)
 }
 
 // Logout provides the logout functionality given the registry name.
 //
-// Deprecated: This function is deprecated.
-// The same functionality is now provided by oras-go.
+// Deprecated: This funciton now simply calls [credentials.Logout] of oras-go.
+//
+// [credentials.Logout]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials#Logout
 func Logout(ctx context.Context, store Store, registryName string) error {
 	return orascreds.Logout(ctx, store, registryName)
 }
 
 // Credential returns a Credential() function that can be used by auth.Client.
 //
-// Deprecated: This function is deprecated.
-// The same functionality is now provided by oras-go.
+// Deprecated: This funciton now simply calls [credentials.Credential] of oras-go.
+//
+// [credentials.Credential]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials#Credential
 func Credential(store Store) func(context.Context, string) (auth.Credential, error) {
 	return orascreds.Credential(store)
 }
@@ -62,8 +66,9 @@ func Credential(store Store) func(context.Context, string) (auth.Credential, err
 // the registry 'docker.io' will be added under the key "https://index.docker.io/v1/".
 // See: https://github.com/moby/moby/blob/v24.0.2/registry/config.go#L25-L48
 //
-// Deprecated: This function is deprecated.
-// The same functionality is now provided by oras-go.
+// Deprecated: This funciton now simply calls [credentials.ServerAddressFromRegistry] of oras-go.
+//
+// [credentials.ServerAddressFromRegistry]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials#ServerAddressFromRegistry
 func ServerAddressFromRegistry(registry string) string {
 	return orascreds.ServerAddressFromRegistry(registry)
 }
@@ -73,8 +78,9 @@ func ServerAddressFromRegistry(registry string) string {
 // host "registry-1.docker.io" will be redirected to "https://index.docker.io/v1/".
 // See: https://github.com/moby/moby/blob/v24.0.2/registry/config.go#L25-L48
 //
-// Deprecated: This function is deprecated.
-// The same functionality is now provided by oras-go.
+// Deprecated: This funciton now simply calls [credentials.ServerAddressFromHostname] of oras-go.
+//
+// [credentials.ServerAddressFromHostname]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials#ServerAddressFromHostname
 func ServerAddressFromHostname(hostname string) string {
 	return orascreds.ServerAddressFromHostname(hostname)
 }

store.go

@@ -14,9 +14,9 @@ limitations under the License.
 */
 
 // Deprecated: This package is deprecated.
-// The same functionality is now provided by [oras-go].
+// The same functionality is now provided by [oras.land/oras-go/v2/registry/remote/credentials].
 //
-// [oras-go]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials
+// [oras.land/oras-go/v2/registry/remote/credentials]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials
 package credentials
 
 import (
@@ -25,21 +25,24 @@ import (
 
 // Store is the interface that any credentials store must implement.
 //
-// Deprecated: This type is deprecated.
-// The same functionality is now provided by oras-go.
+// Deprecated: This type is now simply [credentials.Store] of oras-go.
+//
+// [credentials.Store]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials#Store
 type Store = orascreds.Store
 
 // DynamicStore dynamically determines which store to use based on the settings
 // in the config file.
 //
-// Deprecated: This type is deprecated.
-// The same functionality is now provided by oras-go.
+// Deprecated: This type is now simply [credentials.DynamicStore] of oras-go.
+//
+// [credentials.DynamicStore]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials#DynamicStore
 type DynamicStore = orascreds.DynamicStore
 
 // StoreOptions provides options for NewStore.
 //
-// Deprecated: This type is deprecated.
-// The same functionality is now provided by oras-go.
+// Deprecated: This type is now simply [credentials.StoreOptions] of oras-go.
+//
+// [credentials.StoreOptions]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials#StoreOptions
 type StoreOptions = orascreds.StoreOptions
 
 // NewStore returns a Store based on the given configuration file.
@@ -55,8 +58,9 @@ type StoreOptions = orascreds.StoreOptions
 //   - https://docs.docker.com/engine/reference/commandline/login/#credentials-store
 //   - https://docs.docker.com/engine/reference/commandline/cli/#docker-cli-configuration-file-configjson-properties
 //
-// Deprecated: This function is deprecated.
-// The same functionality is now provided by oras-go.
+// Deprecated: This funciton now simply calls [credentials.NewStore] of oras-go.
+//
+// [credentials.NewStore]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials#NewStore
 func NewStore(configPath string, opts StoreOptions) (*DynamicStore, error) {
 	return orascreds.NewStore(configPath, opts)
 }
@@ -72,8 +76,9 @@ func NewStore(configPath string, opts StoreOptions) (*DynamicStore, error) {
 //   - https://docs.docker.com/engine/reference/commandline/cli/#configuration-files
 //   - https://docs.docker.com/engine/reference/commandline/cli/#change-the-docker-directory
 //
-// Deprecated: This function is deprecated.
-// The same functionality is now provided by oras-go.
+// Deprecated: This funciton now simply calls [credentials.NewStoreFromDocker] of oras-go.
+//
+// [credentials.NewStoreFromDocker]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials#NewStoreFromDocker
 func NewStoreFromDocker(opts StoreOptions) (*DynamicStore, error) {
 	return orascreds.NewStoreFromDocker(opts)
 }
@@ -85,8 +90,9 @@ func NewStoreFromDocker(opts StoreOptions) (*DynamicStore, error) {
 //   - Put() saves the credentials into the primary store.
 //   - Delete() deletes the credentials from the primary store.
 //
-// Deprecated: This function is deprecated.
-// The same functionality is now provided by oras-go.
+// Deprecated: This funciton now simply calls [credentials.NewStoreWithFallbacks] of oras-go.
+//
+// [credentials.NewStoreWithFallbacks]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials#NewStoreWithFallbacks
 func NewStoreWithFallbacks(primary Store, fallbacks ...Store) Store {
 	return orascreds.NewStoreWithFallbacks(primary, fallbacks...)
 }

trace/trace.go

@@ -14,9 +14,9 @@ limitations under the License.
 */
 
 // Deprecated: This package is deprecated.
-// The same functionality is now provided by [oras-go].
+// The same functionality is now provided by [oras.land/oras-go/v2/registry/remote/credentials/trace].
 //
-// [oras-go]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials/trace
+// [oras.land/oras-go/v2/registry/remote/credentials/trace]: https://pkg.go.dev/oras.land/oras-go/v2/registry/remote/credentials/trace
 package trace
 
 import (
@@ -25,22 +25,20 @@ import (
 	orastrace "oras.land/oras-go/v2/registry/remote/credentials/trace"
 )
 
-// executableTraceContextKey is a value key used to retrieve the ExecutableTrace
-// from Context.
-type executableTraceContextKey struct{}
-
 // ExecutableTrace is a set of hooks used to trace the execution of binary
 // executables. Any particular hook may be nil.
 //
-// Deprecated: This type is deprecated.
-// The same functionality is now provided by oras-go.
+// Deprecated: This type is now simply [trace.ExecutableTrace] of oras-go.
+//
+// [trace.ExecutableTrace]: http://localhost:6060/pkg/github.com/oras-project/oras-credentials-go/trace/#ExecutableTrace
 type ExecutableTrace = orastrace.ExecutableTrace
 
 // ContextExecutableTrace returns the ExecutableTrace associated with the
 // context. If none, it returns nil.
 //
-// Deprecated: This type is deprecated.
-// The same functionality is now provided by oras-go.
+// Deprecated: This function now simply calls [trace.ContextExecutableTrace] of oras-go.
+//
+// [trace.ContextExecutableTrace]: http://localhost:6060/pkg/github.com/oras-project/oras-credentials-go/trace/#ContextExecutableTrace
 func ContextExecutableTrace(ctx context.Context) *ExecutableTrace {
 	return orastrace.ContextExecutableTrace(ctx)
 }
@@ -50,8 +48,9 @@ func ContextExecutableTrace(ctx context.Context) *ExecutableTrace {
 // previously added trace, the hooks defined in the new trace will be added
 // in addition to the previous ones. The recent hooks will be called first.
 //
-// Deprecated: This type is deprecated.
-// The same functionality is now provided by oras-go.
+// Deprecated: This function now simply calls [trace.WithExecutableTrace] of oras-go.
+//
+// [trace.WithExecutableTrace]: http://localhost:6060/pkg/github.com/oras-project/oras-credentials-go/trace/#WithExecutableTrace
 func WithExecutableTrace(ctx context.Context, trace *ExecutableTrace) context.Context {
 	return orastrace.WithExecutableTrace(ctx, trace)
 }