Merge pull request #4192 from thaJeztah/registry_fix_ResolveAuthConfig_docs

cli/command: fix documentation for ResolveAuthConfig
This commit is contained in:
Sebastiaan van Stijn
2023-04-12 12:36:22 +02:00
committed by GitHub
+6 -3
View File
@@ -49,9 +49,12 @@ func RegistryAuthenticationPrivilegedFunc(cli Cli, index *registrytypes.IndexInf
}
}
// ResolveAuthConfig is like registry.ResolveAuthConfig, but if using the
// default index, it uses the default index name for the daemon's platform,
// not the client's platform.
// ResolveAuthConfig returns auth-config for the given registry from the
// credential-store. It returns an empty AuthConfig if no credentials were
// found.
//
// It is similar to [registry.ResolveAuthConfig], but uses the credentials-
// store, instead of looking up credentials from a map.
func ResolveAuthConfig(_ context.Context, cli Cli, index *registrytypes.IndexInfo) registrytypes.AuthConfig {
configKey := index.Name
if index.Official {