Skip to content

Commit 44a9a00

Browse files
crazy-maxcrazy-max
committed
history: copy update
Signed-off-by: CrazyMax <[email protected]>
1 parent 9730a20 commit 44a9a00

28 files changed

+89
-43
lines changed

‎commands/history/export.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -139,8 +139,8 @@ func exportCmd(dockerCli command.Cli, rootOpts RootOptions) *cobra.Command {
139139
var options exportOptions
140140

141141
cmd := &cobra.Command{
142-
Use: "export [OPTIONS] [REF]",
143-
Short: "Export a build into Docker Desktop bundle",
142+
Use: "export [OPTIONS] [REF...]",
143+
Short: "Export build records into Docker Desktop bundle",
144144
RunE: func(cmd *cobra.Command, args []string) error {
145145
if options.all && len(args) > 0 {
146146
return errors.New("cannot specify refs when using --all")

‎commands/history/import.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,8 @@ func importCmd(dockerCli command.Cli, _ RootOptions) *cobra.Command {
119119
var options importOptions
120120

121121
cmd := &cobra.Command{
122-
Use: "import [OPTIONS] < bundle.dockerbuild",
123-
Short: "Import a build into Docker Desktop",
122+
Use: "import [OPTIONS] -",
123+
Short: "Import build records into Docker Desktop",
124124
Args: cobra.NoArgs,
125125
RunE: func(cmd *cobra.Command, args []string) error {
126126
return runImport(cmd.Context(), dockerCli, options)

‎commands/history/inspect.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -648,7 +648,7 @@ func inspectCmd(dockerCli command.Cli, rootOpts RootOptions) *cobra.Command {
648648

649649
cmd := &cobra.Command{
650650
Use: "inspect [OPTIONS] [REF]",
651-
Short: "Inspect a build",
651+
Short: "Inspect a build record",
652652
Args: cobra.MaximumNArgs(1),
653653
RunE: func(cmd *cobra.Command, args []string) error {
654654
if len(args) > 0 {

‎commands/history/inspect_attachment.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ func attachmentCmd(dockerCli command.Cli, rootOpts RootOptions) *cobra.Command {
113113

114114
cmd := &cobra.Command{
115115
Use: "attachment [OPTIONS] REF [DIGEST]",
116-
Short: "Inspect a build attachment",
116+
Short: "Inspect a build record attachment",
117117
Args: cobra.RangeArgs(1, 2),
118118
RunE: func(cmd *cobra.Command, args []string) error {
119119
if len(args) > 0 {

‎commands/history/logs.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ func logsCmd(dockerCli command.Cli, rootOpts RootOptions) *cobra.Command {
9898

9999
cmd := &cobra.Command{
100100
Use: "logs [OPTIONS] [REF]",
101-
Short: "Print the logs of a build",
101+
Short: "Print the logs of a build record",
102102
Args: cobra.MaximumNArgs(1),
103103
RunE: func(cmd *cobra.Command, args []string) error {
104104
if len(args) > 0 {

‎commands/history/ls.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ func lsCmd(dockerCli command.Cli, rootOpts RootOptions) *cobra.Command {
107107
var options lsOptions
108108

109109
cmd := &cobra.Command{
110-
Use: "ls",
110+
Use: "ls [OPTIONS]",
111111
Short: "List build records",
112112
Args: cli.NoArgs,
113113
RunE: func(cmd *cobra.Command, args []string) error {

‎commands/history/open.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ func openCmd(dockerCli command.Cli, rootOpts RootOptions) *cobra.Command {
5757

5858
cmd := &cobra.Command{
5959
Use: "open [OPTIONS] [REF]",
60-
Short: "Open a build in Docker Desktop",
60+
Short: "Open a build record in Docker Desktop",
6161
Args: cobra.MaximumNArgs(1),
6262
RunE: func(cmd *cobra.Command, args []string) error {
6363
if len(args) > 0 {

‎commands/history/trace.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ func traceCmd(dockerCli command.Cli, rootOpts RootOptions) *cobra.Command {
222222

223223
flags := cmd.Flags()
224224
flags.StringVar(&options.addr, "addr", "127.0.0.1:0", "Address to bind the UI server")
225-
flags.StringVar(&options.compare, "compare", "", "Compare with another build reference")
225+
flags.StringVar(&options.compare, "compare", "", "Compare with another build record")
226226

227227
return cmd
228228
}

‎commands/imagetools/create.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ func createCmd(dockerCli command.Cli, opts RootOptions) *cobra.Command {
274274
var options createOptions
275275

276276
cmd := &cobra.Command{
277-
Use: "create [OPTIONS] [SOURCE] [SOURCE...]",
277+
Use: "create [OPTIONS] [SOURCE...]",
278278
Short: "Create a new image based on source images",
279279
RunE: func(cmd *cobra.Command, args []string) error {
280280
options.builder = *opts.Builder

‎commands/rm.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ func rmCmd(dockerCli command.Cli, rootOpts *rootOptions) *cobra.Command {
9999
var options rmOptions
100100

101101
cmd := &cobra.Command{
102-
Use: "rm [OPTIONS] [NAME] [NAME...]",
102+
Use: "rm [OPTIONS] [NAME...]",
103103
Short: "Remove one or more builder instances",
104104
RunE: func(cmd *cobra.Command, args []string) error {
105105
options.builders = []string{rootOpts.builder}

‎docs/reference/buildx_dial-stdio.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# docker buildx dial-stdio
22

3+
```text
4+
docker buildx dial-stdio [OPTIONS] < in.fifo > out.fifo &
5+
```
6+
37
<!---MARKER_GEN_START-->
48
Proxy current stdio streams to builder instance
59

@@ -17,13 +21,15 @@ Proxy current stdio streams to builder instance
1721

1822
## Description
1923

20-
dial-stdio uses the stdin and stdout streams of the command to proxy to the configured builder instance.
21-
It is not intended to be used by humans, but rather by other tools that want to interact with the builder instance via BuildKit API.
24+
dial-stdio uses the stdin and stdout streams of the command to proxy to the
25+
configured builder instance. It is not intended to be used by humans, but
26+
rather by other tools that want to interact with the builder instance via
27+
BuildKit API.
2228

2329
## Examples
2430

2531
Example go program that uses the dial-stdio command wire up a buildkit client.
26-
This is for example use only and may not be suitable for production use.
32+
This is, for example, use only and may not be suitable for production use.
2733

2834
```go
2935
client.New(ctx, "", client.WithContextDialer(func(context.Context, string) (net.Conn, error) {
@@ -45,4 +51,4 @@ client.New(ctx, "", client.WithContextDialer(func(context.Context, string) (net.
4551

4652
return c2
4753
}))
48-
```
54+
```

‎docs/reference/buildx_du.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# buildx du
22

33
```text
4-
docker buildx du
4+
docker buildx du [OPTIONS]
55
```
66

77
<!---MARKER_GEN_START-->

‎docs/reference/buildx_history.md

+14-10
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
# docker buildx history
22

3+
```text
4+
docker buildx history [OPTIONS] COMMAND
5+
```
6+
37
<!---MARKER_GEN_START-->
48
Commands to work on build records
59

610
### Subcommands
711

8-
| Name | Description |
9-
|:---------------------------------------|:-----------------------------------------------|
10-
| [`export`](buildx_history_export.md) | Export a build into Docker Desktop bundle |
11-
| [`import`](buildx_history_import.md) | Import a build into Docker Desktop |
12-
| [`inspect`](buildx_history_inspect.md) | Inspect a build |
13-
| [`logs`](buildx_history_logs.md) | Print the logs of a build |
14-
| [`ls`](buildx_history_ls.md) | List build records |
15-
| [`open`](buildx_history_open.md) | Open a build in Docker Desktop |
16-
| [`rm`](buildx_history_rm.md) | Remove build records |
17-
| [`trace`](buildx_history_trace.md) | Show the OpenTelemetry trace of a build record |
12+
| Name | Description |
13+
|:---------------------------------------|:------------------------------------------------|
14+
| [`export`](buildx_history_export.md) | Export build records into Docker Desktop bundle |
15+
| [`import`](buildx_history_import.md) | Import build records into Docker Desktop |
16+
| [`inspect`](buildx_history_inspect.md) | Inspect a build record |
17+
| [`logs`](buildx_history_logs.md) | Print the logs of a build record |
18+
| [`ls`](buildx_history_ls.md) | List build records |
19+
| [`open`](buildx_history_open.md) | Open a build record in Docker Desktop |
20+
| [`rm`](buildx_history_rm.md) | Remove build records |
21+
| [`trace`](buildx_history_trace.md) | Show the OpenTelemetry trace of a build record |
1822

1923

2024
### Options

‎docs/reference/buildx_history_export.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
# docker buildx history export
22

3+
```text
4+
docker buildx history export [OPTIONS] [REF...]
5+
```
6+
37
<!---MARKER_GEN_START-->
4-
Export a build into Docker Desktop bundle
8+
Export build records into Docker Desktop bundle
59

610
### Options
711

‎docs/reference/buildx_history_import.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
# docker buildx history import
22

3+
```text
4+
docker buildx history import [OPTIONS] -
5+
```
6+
37
<!---MARKER_GEN_START-->
4-
Import a build into Docker Desktop
8+
Import build records into Docker Desktop
59

610
### Options
711

‎docs/reference/buildx_history_inspect.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
11
# docker buildx history inspect
22

3+
```text
4+
docker buildx history inspect [OPTIONS] [REF|COMMAND]
5+
```
6+
37
<!---MARKER_GEN_START-->
4-
Inspect a build
8+
Inspect a build record
59

610
### Subcommands
711

8-
| Name | Description |
9-
|:-----------------------------------------------------|:---------------------------|
10-
| [`attachment`](buildx_history_inspect_attachment.md) | Inspect a build attachment |
12+
| Name | Description |
13+
|:-----------------------------------------------------|:----------------------------------|
14+
| [`attachment`](buildx_history_inspect_attachment.md) | Inspect a build record attachment |
1115

1216

1317
### Options

‎docs/reference/buildx_history_inspect_attachment.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
# docker buildx history inspect attachment
22

3+
```text
4+
docker buildx history inspect attachment [OPTIONS] REF [DIGEST]
5+
```
6+
37
<!---MARKER_GEN_START-->
4-
Inspect a build attachment
8+
Inspect a build record attachment
59

610
### Options
711

‎docs/reference/buildx_history_logs.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
# docker buildx history logs
22

3+
```text
4+
docker buildx history logs [OPTIONS] [REF]
5+
```
6+
37
<!---MARKER_GEN_START-->
4-
Print the logs of a build
8+
Print the logs of a build record
59

610
### Options
711

‎docs/reference/buildx_history_ls.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# docker buildx history ls
22

3+
```text
4+
docker buildx history ls [OPTIONS]
5+
```
6+
37
<!---MARKER_GEN_START-->
48
List build records
59

‎docs/reference/buildx_history_open.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
# docker buildx history open
22

3+
```text
4+
docker buildx history open [OPTIONS] [REF]
5+
```
6+
37
<!---MARKER_GEN_START-->
4-
Open a build in Docker Desktop
8+
Open a build record in Docker Desktop
59

610
### Options
711

‎docs/reference/buildx_history_rm.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# docker buildx history rm
22

3+
```text
4+
docker buildx history rm [OPTIONS] [REF...]
5+
```
6+
37
<!---MARKER_GEN_START-->
48
Remove build records
59

‎docs/reference/buildx_history_trace.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# docker buildx history trace
22

3+
```text
4+
docker buildx history trace [OPTIONS] [REF]
5+
```
6+
37
<!---MARKER_GEN_START-->
48
Show the OpenTelemetry trace of a build record
59

@@ -9,7 +13,7 @@ Show the OpenTelemetry trace of a build record
913
|:----------------|:---------|:--------------|:-----------------------------------------|
1014
| `--addr` | `string` | `127.0.0.1:0` | Address to bind the UI server |
1115
| `--builder` | `string` | | Override the configured builder instance |
12-
| `--compare` | `string` | | Compare with another build reference |
16+
| `--compare` | `string` | | Compare with another build record |
1317
| `-D`, `--debug` | `bool` | | Enable debug logging |
1418

1519

‎docs/reference/buildx_imagetools_create.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# buildx imagetools create
22

33
```text
4-
docker buildx imagetools create [OPTIONS] [SOURCE] [SOURCE...]
4+
docker buildx imagetools create [OPTIONS] [SOURCE...]
55
```
66

77
<!---MARKER_GEN_START-->

‎docs/reference/buildx_ls.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# buildx ls
22

33
```text
4-
docker buildx ls
4+
docker buildx ls [OPTIONS]
55
```
66

77
<!---MARKER_GEN_START-->

‎docs/reference/buildx_prune.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# buildx prune
22

33
```text
4-
docker buildx prune
4+
docker buildx prune [OPTIONS]
55
```
66

77
<!---MARKER_GEN_START-->

‎docs/reference/buildx_rm.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# buildx rm
22

33
```text
4-
docker buildx rm [OPTIONS] [NAME] [NAME...]
4+
docker buildx rm [OPTIONS] [NAME...]
55
```
66

77
<!---MARKER_GEN_START-->

‎docs/reference/buildx_stop.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# buildx stop
22

3-
```
3+
```text
44
docker buildx stop [NAME]
55
```
66

‎docs/reference/buildx_use.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# buildx use
22

3-
```
3+
```text
44
docker buildx use [OPTIONS] NAME
55
```
66

0 commit comments

Comments
 (0)