Skip to content

Commit

Permalink
Merge pull request #4196 from thaJeztah/23.0_backport_registry_fix_Re…
Browse files Browse the repository at this point in the history
…solveAuthConfig_docs

[23.0 backport] cli/command: fix documentation for ResolveAuthConfig
  • Loading branch information
thaJeztah authored Apr 13, 2023
2 parents 0b3f540 + 4b4d7e2 commit ad7ae5a
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions cli/command/registry.go
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,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) types.AuthConfig {
configKey := index.Name
if index.Official {
Expand Down

0 comments on commit ad7ae5a

Please sign in to comment.