From 80884714dea5b0d764892e495a30cc13864326d8 Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Wed, 6 Aug 2025 17:15:32 +0200 Subject: [PATCH] cli/command: remove AddPlatformFlag utility It was only used internally and has no external users. It should not be used for new uses, because it also adds a minimum API version constraint and a default from env-var, which must be evaluated for each individual use of such flags. Signed-off-by: Sebastiaan van Stijn (cherry picked from commit 7026e68a7195f2bd9a6b9b5c6ce0e5e38e20973d) Signed-off-by: Sebastiaan van Stijn --- cli/command/container/create.go | 5 ++++- cli/command/container/opts.go | 10 ++++++++++ cli/command/container/run.go | 3 ++- cli/command/image/import.go | 2 +- cli/command/image/opts.go | 17 +++++++++++++++++ cli/command/image/pull.go | 2 +- cli/command/utils.go | 7 ------- 7 files changed, 35 insertions(+), 11 deletions(-) create mode 100644 cli/command/image/opts.go diff --git a/cli/command/container/create.go b/cli/command/container/create.go index 4d58d00ae2..736ee568ea 100644 --- a/cli/command/container/create.go +++ b/cli/command/container/create.go @@ -86,7 +86,10 @@ func NewCreateCommand(dockerCli command.Cli) *cobra.Command { // with hostname flags.Bool("help", false, "Print usage") - command.AddPlatformFlag(flags, &options.platform) + // TODO(thaJeztah): consider adding platform as "image create option" on containerOptions + addPlatformFlag(flags, &options.platform) + _ = cmd.RegisterFlagCompletionFunc("platform", completion.Platforms) + flags.BoolVar(&options.untrusted, "disable-content-trust", !dockerCli.ContentTrustEnabled(), "Skip image verification") copts = addFlags(flags) diff --git a/cli/command/container/opts.go b/cli/command/container/opts.go index 647dc5d510..16b9176db9 100644 --- a/cli/command/container/opts.go +++ b/cli/command/container/opts.go @@ -141,6 +141,16 @@ type containerOptions struct { Args []string } +// addPlatformFlag adds "--platform" to a set of flags for API version 1.32 and +// later, using the value of "DOCKER_DEFAULT_PLATFORM" (if set) as a default. +// +// It should not be used for new uses, which may have a different API version +// requirement. +func addPlatformFlag(flags *pflag.FlagSet, target *string) { + flags.StringVar(target, "platform", os.Getenv("DOCKER_DEFAULT_PLATFORM"), "Set platform if server is multi-platform capable") + _ = flags.SetAnnotation("platform", "version", []string{"1.32"}) +} + // addFlags adds all command line flags that will be used by parse to the FlagSet func addFlags(flags *pflag.FlagSet) *containerOptions { copts := &containerOptions{ diff --git a/cli/command/container/run.go b/cli/command/container/run.go index 20c1f7ca4b..6c5748a67a 100644 --- a/cli/command/container/run.go +++ b/cli/command/container/run.go @@ -66,7 +66,8 @@ func NewRunCommand(dockerCli command.Cli) *cobra.Command { // with hostname flags.Bool("help", false, "Print usage") - command.AddPlatformFlag(flags, &options.platform) + // TODO(thaJeztah): consider adding platform as "image create option" on containerOptions + addPlatformFlag(flags, &options.platform) flags.BoolVar(&options.untrusted, "disable-content-trust", !dockerCli.ContentTrustEnabled(), "Skip image verification") copts = addFlags(flags) diff --git a/cli/command/image/import.go b/cli/command/image/import.go index a55ea4ab5b..f0da5c6a47 100644 --- a/cli/command/image/import.go +++ b/cli/command/image/import.go @@ -47,7 +47,7 @@ func NewImportCommand(dockerCli command.Cli) *cobra.Command { options.changes = dockeropts.NewListOpts(nil) flags.VarP(&options.changes, "change", "c", "Apply Dockerfile instruction to the created image") flags.StringVarP(&options.message, "message", "m", "", "Set commit message for imported image") - command.AddPlatformFlag(flags, &options.platform) + addPlatformFlag(flags, &options.platform) _ = cmd.RegisterFlagCompletionFunc("platform", completion.Platforms) return cmd diff --git a/cli/command/image/opts.go b/cli/command/image/opts.go new file mode 100644 index 0000000000..37378b6ece --- /dev/null +++ b/cli/command/image/opts.go @@ -0,0 +1,17 @@ +package image + +import ( + "os" + + "github.com/spf13/pflag" +) + +// addPlatformFlag adds "--platform" to a set of flags for API version 1.32 and +// later, using the value of "DOCKER_DEFAULT_PLATFORM" (if set) as a default. +// +// It should not be used for new uses, which may have a different API version +// requirement. +func addPlatformFlag(flags *pflag.FlagSet, target *string) { + flags.StringVar(target, "platform", os.Getenv("DOCKER_DEFAULT_PLATFORM"), "Set platform if server is multi-platform capable") + _ = flags.SetAnnotation("platform", "version", []string{"1.32"}) +} diff --git a/cli/command/image/pull.go b/cli/command/image/pull.go index 5e4b3736ca..c916bad24f 100644 --- a/cli/command/image/pull.go +++ b/cli/command/image/pull.go @@ -50,7 +50,7 @@ func NewPullCommand(dockerCli command.Cli) *cobra.Command { flags.BoolVarP(&opts.all, "all-tags", "a", false, "Download all tagged images in the repository") flags.BoolVarP(&opts.quiet, "quiet", "q", false, "Suppress verbose output") - command.AddPlatformFlag(flags, &opts.platform) + addPlatformFlag(flags, &opts.platform) flags.BoolVar(&opts.untrusted, "disable-content-trust", !dockerCli.ContentTrustEnabled(), "Skip image verification") _ = cmd.RegisterFlagCompletionFunc("platform", completion.Platforms) diff --git a/cli/command/utils.go b/cli/command/utils.go index f024ffd278..5987b53717 100644 --- a/cli/command/utils.go +++ b/cli/command/utils.go @@ -15,7 +15,6 @@ import ( "github.com/docker/cli/internal/prompt" "github.com/docker/docker/api/types/filters" "github.com/pkg/errors" - "github.com/spf13/pflag" ) const ErrPromptTerminated = prompt.ErrTerminated @@ -94,12 +93,6 @@ func PruneFilters(dockerCLI config.Provider, pruneFilters filters.Args) filters. return pruneFilters } -// AddPlatformFlag adds `platform` to a set of flags for API version 1.32 and later. -func AddPlatformFlag(flags *pflag.FlagSet, target *string) { - flags.StringVar(target, "platform", os.Getenv("DOCKER_DEFAULT_PLATFORM"), "Set platform if server is multi-platform capable") - _ = flags.SetAnnotation("platform", "version", []string{"1.32"}) -} - // ValidateOutputPath validates the output paths of the "docker cp" command. func ValidateOutputPath(path string) error { dir := filepath.Dir(filepath.Clean(path))