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 <[email protected]> (cherry picked from commit 5bd3591) Signed-off-by: Sebastiaan van Stijn <[email protected]>
docker · Apr 12, 2023 · 4b4d7e2 · 4b4d7e2
1 parent 8b783cc
commit 4b4d7e2
Showing 1 changed file with 6 additions and 3 deletions.
diff --git a/cli/command/registry.go b/cli/command/registry.go
@@ -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 {