Skip to content

Commit 6ed39b2

Browse files
sarahsanders-dockertonistiigi
authored andcommitted
fix examples and headings
Signed-off-by: sarahsanders-docker <sarah.sanders@docker.com>
1 parent 0301904 commit 6ed39b2

9 files changed

Lines changed: 55 additions & 41 deletions

docs/reference/buildx_history_export.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ Export a build into Docker Desktop bundle
77

88
| Name | Type | Default | Description |
99
|:-----------------|:---------|:--------|:-----------------------------------------|
10-
| `--all` | `bool` | | Export all records for the builder |
11-
| `--builder` | `string` | | Override the configured builder instance |
10+
| [`--all`](#all) | `bool` | | Export all records for the builder |
11+
| [`--builder`](#builder) | `string` | | Override the configured builder instance |
1212
| `-D`, `--debug` | `bool` | | Enable debug logging |
13-
| `-o`, `--output` | `string` | | Output file path |
13+
| [`-o`](#o), [`--output`](#output) | `string` | | Output file path |
1414

1515

1616
<!---MARKER_GEN_END-->
@@ -23,7 +23,7 @@ Desktop or shared across environments.
2323

2424
## Examples
2525

26-
### <a name="export-single-build"></a> Export a single build to a custom file
26+
### <a name="output"></a> Export a single build to a custom file (--output)
2727

2828
```console
2929
docker buildx history export qu2gsuo8ejqrwdfii23xkkckt --output mybuild.dockerbuild
@@ -35,7 +35,7 @@ You can find build IDs by running:
3535
docker buildx history ls
3636
```
3737

38-
### <a name="export-multiple-builds"></a> Export multiple builds to individual `.dockerbuild` files
38+
### <a name="o"></a> Export multiple builds to individual `.dockerbuild` files (-o)
3939

4040
To export two builds to separate files:
4141

@@ -54,7 +54,7 @@ docker buildx history export ^1 > mybuild.dockerbuild
5454
docker buildx history export ^2 > backend-build.dockerbuild
5555
```
5656

57-
### <a name="export-all-builds"></a> Export all build records to a file
57+
### <a name="all"></a> Export all build records to a file (--all)
5858

5959
Use the `--all` flag and redirect the output:
6060

@@ -67,3 +67,15 @@ Or use the `--output` flag:
6767
```console
6868
docker buildx history export --all -o all-builds.dockerbuild
6969
```
70+
71+
### <a name="builder"></a> Use a specific builder instance (--builder)
72+
73+
```console
74+
docker buildx history export --builder builder0 ^1 -o builder0-build.dockerbuild
75+
```
76+
77+
### <a name="debug"></a> Enable debug logging (--debug)
78+
79+
```console
80+
docker buildx history export --debug qu2gsuo8ejqrwdfii23xkkckt -o debug-build.dockerbuild
81+
```

docs/reference/buildx_history_import.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Import a build into Docker Desktop
99
|:----------------|:--------------|:--------|:-----------------------------------------|
1010
| `--builder` | `string` | | Override the configured builder instance |
1111
| `-D`, `--debug` | `bool` | | Enable debug logging |
12-
| `-f`, `--file` | `stringArray` | | Import from a file path |
12+
| [`-f`](#file), [`--file`](#file) | `stringArray` | | Import from a file path |
1313

1414

1515
<!---MARKER_GEN_END-->
@@ -22,19 +22,19 @@ pipelines.
2222

2323
## Examples
2424

25-
### <a name="import-dockerbuild"></a> Import a `.dockerbuild` archive from standard input
25+
### Import a `.dockerbuild` archive from standard input
2626

2727
```console
2828
docker buildx history import < mybuild.dockerbuild
2929
```
3030

31-
### <a name="import-build-archive"></a> Import a build archive from a file
31+
### <a name="file"></a> Import a build archive from a file (--file)
3232

3333
```console
3434
docker buildx history import --file ./artifacts/backend-build.dockerbuild
3535
```
3636

37-
### <a name="open-build-manually"></a> Open a build manually
37+
### Open a build manually
3838

3939
By default, the `import` command automatically opens the imported build in Docker
4040
Desktop. You don't need to run `open` unless you're opening a specific build

docs/reference/buildx_history_inspect.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ provenance, SBOMs, or other detailed information.
2929

3030
## Examples
3131

32-
### <a name="inspect-most-recent-build"></a> Inspect the most recent build
32+
### Inspect the most recent build
3333

3434
```console
3535
$ docker buildx history inspect
@@ -59,7 +59,7 @@ DIGEST PLATFORM
5959
sha256:217329d2af959d4f02e3a96dcbe62bf100cab1feb8006a047ddfe51a5397f7e3 https://slsa.dev/provenance/v0.2
6060
```
6161

62-
### <a name="inspect-specific-build"></a> Inspect a specific build
62+
### Inspect a specific build
6363

6464
```console
6565
# Using a build ID

docs/reference/buildx_history_inspect_attachment.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Inspect a build attachment
1010
| `--builder` | `string` | | Override the configured builder instance |
1111
| `-D`, `--debug` | `bool` | | Enable debug logging |
1212
| `--platform` | `string` | | Platform of attachment |
13-
| `--type` | `string` | | Type of attachment |
13+
| [`--type`](#type) | `string` | | Type of attachment |
1414

1515

1616
<!---MARKER_GEN_END-->
@@ -23,7 +23,7 @@ platform-specific.
2323

2424
## Examples
2525

26-
### <a name="inspect-provenance-attachment"></a> Inspect a provenance attachment from a build
26+
### <a name="type"></a> Inspect a provenance attachment from a build (--type)
2727

2828
Supported types include `provenance` and `sbom`.
2929

@@ -45,7 +45,7 @@ $ docker buildx history inspect attachment qu2gsuo8ejqrwdfii23xkkckt --type prov
4545
}
4646
```
4747

48-
### <a name="insepct-SBOM"></a> Inspect a SBOM for linux/amd64
48+
### Inspect a SBOM for linux/amd64
4949

5050
```console
5151
$ docker buildx history inspect attachment ^0 \
@@ -65,7 +65,7 @@ $ docker buildx history inspect attachment ^0 \
6565
}
6666
```
6767

68-
### <a name="inspect-attachment-digest"></a> Inspect an attachment by digest
68+
### Inspect an attachment by digest
6969

7070
You can inspect an attachment directly using its digset, which you can get from
7171
the `inspect` output:

docs/reference/buildx_history_logs.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Print the logs of a build
99
|:----------------|:---------|:--------|:--------------------------------------------------|
1010
| `--builder` | `string` | | Override the configured builder instance |
1111
| `-D`, `--debug` | `bool` | | Enable debug logging |
12-
| `--progress` | `string` | `plain` | Set type of progress output (plain, rawjson, tty) |
12+
| [`--progress`](#progress) | `string` | `plain` | Set type of progress output (plain, rawjson, tty) |
1313

1414

1515
<!---MARKER_GEN_END-->
@@ -28,7 +28,7 @@ You can also specify an earlier build using an offset. For example:
2828

2929
## Examples
3030

31-
### <a name="print-logs-recent-build"></a> Print logs for the most recent build
31+
### Print logs for the most recent build
3232

3333
```console
3434
$ docker buildx history logs
@@ -43,7 +43,7 @@ $ docker buildx history logs
4343

4444
By default, this shows logs for the most recent build on the current builder.
4545

46-
### <a name="print-logs-specific-build"></a> Print logs for a specific build
46+
### Print logs for a specific build
4747

4848
To print logs for a specific build, use a build ID or offset:
4949

@@ -55,7 +55,7 @@ docker buildx history logs qu2gsuo8ejqrwdfii23xkkckt
5555
docker buildx history logs ^1
5656
```
5757

58-
### <a name="print-logs-json"></a> Print logs in JSON format
58+
### <a name="progress"></a> Set type of progress output (--progress)
5959

6060
```console
6161
$ docker buildx history logs ^1 --progress rawjson

docs/reference/buildx_history_ls.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ List build records
99
|:----------------|:--------------|:--------|:---------------------------------------------|
1010
| `--builder` | `string` | | Override the configured builder instance |
1111
| `-D`, `--debug` | `bool` | | Enable debug logging |
12-
| `--filter` | `stringArray` | | Provide filter values (e.g., `status=error`) |
13-
| `--format` | `string` | `table` | Format the output |
14-
| `--local` | `bool` | | List records for current repository only |
15-
| `--no-trunc` | `bool` | | Don't truncate output |
12+
| [`--filter`](#filter) | `stringArray` | | Provide filter values (e.g., `status=error`) |
13+
| [`--format`](#format) | `string` | `table` | Format the output |
14+
| [`--local`](#local) | `bool` | | List records for current repository only |
15+
| [`--no-trunc`](#no-trunc) | `bool` | | Don't truncate output |
1616

1717

1818
<!---MARKER_GEN_END-->
@@ -27,7 +27,7 @@ results using flags.
2727

2828
## Examples
2929

30-
### <a name="list-build-records-current"></a> List all build records for the current builder
30+
### List all build records for the current builder
3131

3232
```console
3333
$ docker buildx history ls
@@ -37,7 +37,7 @@ qsiifiuf1ad9pa9qvppc0z1l3 .dev/2850 Completed 3 days ago 1.3s
3737
g9808bwrjrlkbhdamxklx660b .dev/3120 Completed 5 days ago 2.1s
3838
```
3939

40-
### <a name="list-failed-builds"></a> List only failed builds
40+
### <a name="filter"></a> List failed builds (--filter)
4141

4242
```console
4343
docker buildx history ls --filter status=error
@@ -56,19 +56,21 @@ You can combine multiple filters by repeating the `--filter` flag:
5656
docker buildx history ls --filter status=error --filter duration>30s
5757
```
5858

59-
### <a name="list-builds-current-project"></a> List builds from the current project
59+
### <a name="local"></a> List builds from the current project (--local)
6060

6161
```console
6262
docker buildx history ls --local
6363
```
6464

65-
### <a name="display-full-output"></a> Display full output without truncation
65+
### <a name="no-trunc"></a> Display full output without truncation (--no-trunc)
6666

6767
```console
6868
docker buildx history ls --no-trunc
6969
```
7070

71-
### <a name="list-as-json"></a> Format output as JSON
71+
### <a name="format"></a> Format output (--format)
72+
73+
**JSON output**
7274

7375
```console
7476
$ docker buildx history ls --format json
@@ -90,7 +92,7 @@ $ docker buildx history ls --format json
9092
]
9193
```
9294

93-
### <a name="list-go-template"></a> Use a Go template to print name and durations
95+
**Go template output**
9496

9597
```console
9698
$ docker buildx history ls --format '{{.Name}} - {{.Duration}}'

docs/reference/buildx_history_open.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ Docker Desktop to be installed and running on the host machine.
2020

2121
## Examples
2222

23-
### <a name="open-most-recent-build"></a> Open the most recent build in Docker Desktop
23+
### Open the most recent build in Docker Desktop
2424

2525
```console
2626
docker buildx history open
2727
```
2828

2929
By default, this opens the most recent build on the current builder.
3030

31-
### <a name="open-specific-build"></a> Open a specific build
31+
### Open a specific build
3232

3333
```console
3434
# Using a build ID

docs/reference/buildx_history_rm.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ the `--all` flag.
2222

2323
## Examples
2424

25-
### <a name="remove-specific-build"></a> Remove a specific build
25+
### Remove a specific build
2626

2727
```console
2828
# Using a build ID
@@ -32,7 +32,7 @@ docker buildx history rm qu2gsuo8ejqrwdfii23xkkckt
3232
docker buildx history rm ^1
3333
```
3434

35-
### <a name="remove-multiple-builds"></a> Remove multiple builds
35+
### Remove multiple builds
3636

3737
```console
3838
# Using build IDs
@@ -42,7 +42,7 @@ docker buildx history rm qu2gsuo8ejqrwdfii23xkkckt qsiifiuf1ad9pa9qvppc0z1l3
4242
docker buildx history rm ^1 ^2
4343
```
4444

45-
### <a name="remove-all-build-records"></a> Remove all build records from the current builder
45+
### Remove all build records from the current builder
4646

4747
```console
4848
docker buildx history rm --all

docs/reference/buildx_history_trace.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ Show the OpenTelemetry trace of a build record
77

88
| Name | Type | Default | Description |
99
|:----------------|:---------|:--------------|:-----------------------------------------|
10-
| `--addr` | `string` | `127.0.0.1:0` | Address to bind the UI server |
10+
| [`--addr`](#addr) | `string` | `127.0.0.1:0` | Address to bind the UI server |
1111
| `--builder` | `string` | | Override the configured builder instance |
12-
| `--compare` | `string` | | Compare with another build reference |
12+
| [`--compare`](#compare) | `string` | | Compare with another build reference |
1313
| `-D`, `--debug` | `bool` | | Enable debug logging |
1414

1515

@@ -24,7 +24,7 @@ This helps analyze build performance, step timing, and internal execution flows.
2424

2525
## Examples
2626

27-
### <a name="open-opentelemetry-trace"></a> Open the OpenTelemetry trace for the most recent build
27+
### Open the OpenTelemetry trace for the most recent build
2828

2929
This command starts a temporary Jaeger UI server and opens your default browser
3030
to view the trace.
@@ -33,7 +33,7 @@ to view the trace.
3333
docker buildx history trace
3434
```
3535

36-
### <a name="open-trace-specific-build"></a> Open the trace for a specific build
36+
### Open the trace for a specific build
3737

3838
```console
3939
# Using a build ID
@@ -43,7 +43,7 @@ docker buildx history trace qu2gsuo8ejqrwdfii23xkkckt
4343
docker buildx history trace ^1
4444
```
4545

46-
### <a name="run-Jaegar-UI-port"></a> Run the Jaeger UI on a specific port
46+
### <a name="addr"></a> Run the Jaeger UI on a specific port (--addr)
4747

4848
```console
4949
# Using a build ID
@@ -53,7 +53,7 @@ docker buildx history trace qu2gsuo8ejqrwdfii23xkkckt --addr 127.0.0.1:16686
5353
docker buildx history trace ^1 --addr 127.0.0.1:16686
5454
```
5555

56-
### <a name="compare-traces"></a> Compare two build traces
56+
### <a name="compare"></a> Compare two build traces (--compare)
5757

5858
Compare two specific builds by name:
5959

0 commit comments

Comments
 (0)