Skip to content

Commit 3e43fa2

Browse files
vieuxvieux
committed
always add but hide experimental cmds and flags
Signed-off-by: Victor Vieux <vieux@docker.com>
1 parent c072347 commit 3e43fa2

File tree

5 files changed

+47
-19
lines changed

5 files changed

+47
-19
lines changed

‎cli/command/cli.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ type DockerCli struct {
4545
func (cli *DockerCli) HasExperimental() bool {
4646
if cli.hasExperimental == nil {
4747
if cli.client == nil {
48-
cli.Initialize(cliflags.NewClientOptions())
48+
return false
4949
}
5050
enabled := false
5151
cli.hasExperimental = &enabled

‎cli/command/commands/commands.go‎

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -70,17 +70,12 @@ func AddCommands(cmd *cobra.Command, dockerCli *command.DockerCli) {
7070
hide(image.NewSaveCommand(dockerCli)),
7171
hide(image.NewTagCommand(dockerCli)),
7272
hide(system.NewInspectCommand(dockerCli)),
73+
stack.NewStackCommand(dockerCli),
74+
stack.NewTopLevelDeployCommand(dockerCli),
75+
checkpoint.NewCheckpointCommand(dockerCli),
76+
plugin.NewPluginCommand(dockerCli),
7377
)
7478

75-
if dockerCli.HasExperimental() {
76-
cmd.AddCommand(
77-
stack.NewStackCommand(dockerCli),
78-
stack.NewTopLevelDeployCommand(dockerCli),
79-
checkpoint.NewCheckpointCommand(dockerCli),
80-
plugin.NewPluginCommand(dockerCli),
81-
)
82-
}
83-
8479
}
8580

8681
func hide(cmd *cobra.Command) *cobra.Command {

‎cli/command/container/start.go‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,10 @@ func NewStartCommand(dockerCli *command.DockerCli) *cobra.Command {
4545
flags.BoolVarP(&opts.openStdin, "interactive", "i", false, "Attach container's STDIN")
4646
flags.StringVar(&opts.detachKeys, "detach-keys", "", "Override the key sequence for detaching a container")
4747

48-
if dockerCli.HasExperimental() {
49-
flags.StringVar(&opts.checkpoint, "checkpoint", "", "Restore from this checkpoint")
50-
flags.StringVar(&opts.checkpointDir, "checkpoint-dir", "", "Use a custom checkpoint storage directory")
51-
}
52-
48+
flags.StringVar(&opts.checkpoint, "checkpoint", "", "Restore from this checkpoint")
49+
flags.StringVar(&opts.checkpointDir, "checkpoint-dir", "", "Use a custom checkpoint storage directory")
50+
flags.SetAnnotation("checkpoint", "experimental", nil)
51+
flags.SetAnnotation("checkpoint-dir", "experimental", nil)
5352
return cmd
5453
}
5554

‎cli/command/image/build.go‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,8 @@ func NewBuildCommand(dockerCli *command.DockerCli) *cobra.Command {
111111

112112
command.AddTrustedFlags(flags, true)
113113

114-
if dockerCli.HasExperimental() {
115-
flags.BoolVar(&options.squash, "squash", false, "Squash newly built layers into a single new layer")
116-
}
114+
flags.BoolVar(&options.squash, "squash", false, "Squash newly built layers into a single new layer")
115+
flags.SetAnnotation("squash", "experimental", nil)
117116

118117
return cmd
119118
}

‎cmd/docker/docker.go‎

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ package main
33
import (
44
"fmt"
55
"os"
6+
"strings"
67

78
"github.com/Sirupsen/logrus"
89
"github.com/docker/docker/cli"
@@ -33,7 +34,8 @@ func newDockerCommand(dockerCli *command.DockerCli) *cobra.Command {
3334
showVersion()
3435
return nil
3536
}
36-
fmt.Fprintf(dockerCli.Err(), "\n"+cmd.UsageString())
37+
cmd.SetOutput(dockerCli.Err())
38+
cmd.HelpFunc()(cmd, args)
3739
return nil
3840
},
3941
PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
@@ -45,6 +47,22 @@ func newDockerCommand(dockerCli *command.DockerCli) *cobra.Command {
4547
}
4648
cli.SetupRootCommand(cmd)
4749

50+
cmd.SetHelpFunc(func(ccmd *cobra.Command, args []string) {
51+
var err error
52+
if dockerCli.Client() == nil {
53+
// flags must be the top-level command flags, not cmd.Flags()
54+
opts.Common.SetDefaultOptions(flags)
55+
dockerPreRun(opts)
56+
err = dockerCli.Initialize(opts)
57+
}
58+
if err != nil || !dockerCli.HasExperimental() {
59+
hideExperimentalFeatures(ccmd)
60+
}
61+
if err := ccmd.Help(); err != nil {
62+
ccmd.Println(err)
63+
}
64+
})
65+
4866
flags = cmd.Flags()
4967
flags.BoolVarP(&opts.Version, "version", "v", false, "Print version information and quit")
5068
flags.StringVar(&opts.ConfigDir, "config", cliconfig.ConfigDir(), "Location of client config files")
@@ -105,3 +123,20 @@ func dockerPreRun(opts *cliflags.ClientOptions) {
105123
utils.EnableDebug()
106124
}
107125
}
126+
127+
func hideExperimentalFeatures(cmd *cobra.Command) {
128+
// hide flags
129+
cmd.Flags().VisitAll(func(f *pflag.Flag) {
130+
if _, ok := f.Annotations["experimental"]; ok {
131+
f.Hidden = true
132+
}
133+
})
134+
135+
for _, subcmd := range cmd.Commands() {
136+
// hide subcommands
137+
name := strings.Split(subcmd.Use, " ")[0]
138+
if name == "stack" || name == "deploy" || name == "checkpoint" || name == "plugin" {
139+
subcmd.Hidden = true
140+
}
141+
}
142+
}

0 commit comments

Comments
 (0)