Skip to content

Commit 5bd3591

Browse files
committed
cli/command: fix documentation for ResolveAuthConfig
This function no longer uses the /info endpoint to resolve the registry to use. The documentation for this function was still referring to the (once used) special registry for Windows images, which is no longer in use, so update the docs to reflect reality :) Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
1 parent 6233560 commit 5bd3591

1 file changed

Lines changed: 6 additions & 3 deletions

File tree

cli/command/registry.go

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,12 @@ func RegistryAuthenticationPrivilegedFunc(cli Cli, index *registrytypes.IndexInf
4949
}
5050
}
5151

52-
// ResolveAuthConfig is like registry.ResolveAuthConfig, but if using the
53-
// default index, it uses the default index name for the daemon's platform,
54-
// not the client's platform.
52+
// ResolveAuthConfig returns auth-config for the given registry from the
53+
// credential-store. It returns an empty AuthConfig if no credentials were
54+
// found.
55+
//
56+
// It is similar to [registry.ResolveAuthConfig], but uses the credentials-
57+
// store, instead of looking up credentials from a map.
5558
func ResolveAuthConfig(_ context.Context, cli Cli, index *registrytypes.IndexInfo) registrytypes.AuthConfig {
5659
configKey := index.Name
5760
if index.Official {

0 commit comments

Comments
 (0)