Skip to content

Commit 7d56538

Browse files
dvdksndvdksn
committed
test: add root flags for tests
Adds a hidden --help flag (like in docker/cli) and a dummy -H flag Signed-off-by: David Karlsson <[email protected]>
1 parent 7142e86 commit 7d56538

16 files changed

+97
-30
lines changed

‎clidocstool_test.go

+5
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,11 @@ func setup() {
5454
DisableFlagsInUseLine: true,
5555
}
5656

57+
dockerCmd.PersistentFlags().BoolP("help", "h", false, "Print usage")
58+
dockerCmd.PersistentFlags().MarkShorthandDeprecated("help", "please use --help")
59+
dockerCmd.PersistentFlags().Lookup("help").Hidden = true
60+
dockerCmd.Flags().StringP("host", "H", "unix:///var/run/docker.sock", "Daemon socket to connect to")
61+
5762
attachCmd = &cobra.Command{
5863
Use: "attach [OPTIONS] CONTAINER",
5964
Short: "Attach local standard input, output, and error streams to a running container",

‎fixtures/docker-attach.1

-4
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,6 @@ Attach local standard input, output, and error streams to a running container
2121
\fB--detach-keys\fP=""
2222
Override the key sequence for detaching a container
2323

24-
.PP
25-
\fB-h\fP, \fB--help\fP[=false]
26-
help for attach
27-
2824
.PP
2925
\fB--no-stdin\fP[=false]
3026
Do not attach STDIN

‎fixtures/docker-buildx-build.1

-4
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,6 @@ Start a build
4949
\fB-f\fP, \fB--file\fP=""
5050
Name of the Dockerfile (default: "PATH/Dockerfile")
5151

52-
.PP
53-
\fB-h\fP, \fB--help\fP[=false]
54-
help for build
55-
5652
.PP
5753
\fB--iidfile\fP=""
5854
Write the image ID to the file

‎fixtures/docker-buildx-dial-stdio.1

-4
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,6 @@ Proxy current stdio streams to builder instance
1717

1818

1919
.SH OPTIONS
20-
.PP
21-
\fB-h\fP, \fB--help\fP[=false]
22-
help for dial-stdio
23-
2420
.PP
2521
\fB--platform\fP=""
2622
Target platform: this is used for node selection

‎fixtures/docker-buildx-install.1

-6
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,6 @@ docker-buildx-install - Install buildx as a 'docker builder' alias
1616
Install buildx as a 'docker builder' alias
1717

1818

19-
.SH OPTIONS
20-
.PP
21-
\fB-h\fP, \fB--help\fP[=false]
22-
help for install
23-
24-
2519
.SH OPTIONS INHERITED FROM PARENT COMMANDS
2620
.PP
2721
\fB--builder\fP=""

‎fixtures/docker-buildx-stop.1

-6
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,6 @@ docker-buildx-stop - Stop builder instance
1616
Stop builder instance
1717

1818

19-
.SH OPTIONS
20-
.PP
21-
\fB-h\fP, \fB--help\fP[=false]
22-
help for stop
23-
24-
2519
.SH OPTIONS INHERITED FROM PARENT COMMANDS
2620
.PP
2721
\fB--builder\fP=""

‎fixtures/docker-buildx.1

-4
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,6 @@ Extended build capabilities with BuildKit
2121
\fB--builder\fP=""
2222
Override the configured builder instance
2323

24-
.PP
25-
\fB-h\fP, \fB--help\fP[=false]
26-
help for buildx
27-
2824

2925
.SH SEE ALSO
3026
.PP

‎fixtures/docker.1

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ A self-sufficient runtime for containers
1818

1919
.SH OPTIONS
2020
.PP
21-
\fB-h\fP, \fB--help\fP[=false]
22-
help for docker
21+
\fB-H\fP, \fB--host\fP="unix:///var/run/docker.sock"
22+
Daemon socket to connect to
2323

2424

2525
.SH SEE ALSO

‎fixtures/docker.md

+6
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ A self-sufficient runtime for containers
1111
| [`buildx`](buildx.md) | Docker Buildx |
1212

1313

14+
### Options
15+
16+
| Name | Type | Default | Description |
17+
|:---------------|:---------|:------------------------------|:----------------------------|
18+
| `-H`, `--host` | `string` | `unix:///var/run/docker.sock` | Daemon socket to connect to |
19+
1420

1521
<!---MARKER_GEN_END-->
1622

‎fixtures/docker.yaml

+22
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,28 @@ cname:
88
clink:
99
- docker_attach.yaml
1010
- docker_buildx.yaml
11+
options:
12+
- option: help
13+
value_type: bool
14+
default_value: "false"
15+
description: Print usage
16+
deprecated: false
17+
hidden: true
18+
experimental: false
19+
experimentalcli: false
20+
kubernetes: false
21+
swarm: false
22+
- option: host
23+
shorthand: H
24+
value_type: string
25+
default_value: unix:///var/run/docker.sock
26+
description: Daemon socket to connect to
27+
deprecated: false
28+
hidden: false
29+
experimental: false
30+
experimentalcli: false
31+
kubernetes: false
32+
swarm: false
1133
deprecated: false
1234
hidden: false
1335
experimental: false

‎fixtures/docker_attach.yaml

+11
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,17 @@ options:
3737
experimentalcli: false
3838
kubernetes: false
3939
swarm: false
40+
inherited_options:
41+
- option: help
42+
value_type: bool
43+
default_value: "false"
44+
description: Print usage
45+
deprecated: false
46+
hidden: true
47+
experimental: false
48+
experimentalcli: false
49+
kubernetes: false
50+
swarm: false
4051
deprecated: false
4152
hidden: false
4253
experimental: false

‎fixtures/docker_buildx.yaml

+11
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,17 @@ options:
2121
experimentalcli: false
2222
kubernetes: false
2323
swarm: false
24+
inherited_options:
25+
- option: help
26+
value_type: bool
27+
default_value: "false"
28+
description: Print usage
29+
deprecated: false
30+
hidden: true
31+
experimental: false
32+
experimentalcli: false
33+
kubernetes: false
34+
swarm: false
2435
deprecated: false
2536
hidden: false
2637
experimental: false

‎fixtures/docker_buildx_build.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -374,6 +374,16 @@ inherited_options:
374374
experimentalcli: false
375375
kubernetes: false
376376
swarm: false
377+
- option: help
378+
value_type: bool
379+
default_value: "false"
380+
description: Print usage
381+
deprecated: false
382+
hidden: true
383+
experimental: false
384+
experimentalcli: false
385+
kubernetes: false
386+
swarm: false
377387
deprecated: false
378388
hidden: false
379389
experimental: false

‎fixtures/docker_buildx_dial-stdio.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,16 @@ inherited_options:
3434
experimentalcli: false
3535
kubernetes: false
3636
swarm: false
37+
- option: help
38+
value_type: bool
39+
default_value: "false"
40+
description: Print usage
41+
deprecated: false
42+
hidden: true
43+
experimental: false
44+
experimentalcli: false
45+
kubernetes: false
46+
swarm: false
3747
deprecated: false
3848
hidden: false
3949
experimental: false

‎fixtures/docker_buildx_install.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,16 @@ inherited_options:
1414
experimentalcli: false
1515
kubernetes: false
1616
swarm: false
17+
- option: help
18+
value_type: bool
19+
default_value: "false"
20+
description: Print usage
21+
deprecated: false
22+
hidden: true
23+
experimental: false
24+
experimentalcli: false
25+
kubernetes: false
26+
swarm: false
1727
deprecated: false
1828
hidden: true
1929
experimental: false

‎fixtures/docker_buildx_stop.yaml

+10
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,16 @@ inherited_options:
1414
experimentalcli: false
1515
kubernetes: false
1616
swarm: false
17+
- option: help
18+
value_type: bool
19+
default_value: "false"
20+
description: Print usage
21+
deprecated: false
22+
hidden: true
23+
experimental: false
24+
experimentalcli: false
25+
kubernetes: false
26+
swarm: false
1727
deprecated: false
1828
hidden: false
1929
experimental: false

0 commit comments

Comments
 (0)