From 6ed39b2618c68c52c295b9d4a9048d0b472c03e6 Mon Sep 17 00:00:00 2001 From: sarahsanders-docker Date: Fri, 25 Apr 2025 09:57:25 -0400 Subject: [PATCH] fix examples and headings Signed-off-by: sarahsanders-docker --- docs/reference/buildx_history_export.md | 24 ++++++++++++++----- docs/reference/buildx_history_import.md | 8 +++---- docs/reference/buildx_history_inspect.md | 4 ++-- .../buildx_history_inspect_attachment.md | 8 +++---- docs/reference/buildx_history_logs.md | 8 +++---- docs/reference/buildx_history_ls.md | 22 +++++++++-------- docs/reference/buildx_history_open.md | 4 ++-- docs/reference/buildx_history_rm.md | 6 ++--- docs/reference/buildx_history_trace.md | 12 +++++----- 9 files changed, 55 insertions(+), 41 deletions(-) diff --git a/docs/reference/buildx_history_export.md b/docs/reference/buildx_history_export.md index de9c750e..1b223798 100644 --- a/docs/reference/buildx_history_export.md +++ b/docs/reference/buildx_history_export.md @@ -7,10 +7,10 @@ Export a build into Docker Desktop bundle | Name | Type | Default | Description | |:-----------------|:---------|:--------|:-----------------------------------------| -| `--all` | `bool` | | Export all records for the builder | -| `--builder` | `string` | | Override the configured builder instance | +| [`--all`](#all) | `bool` | | Export all records for the builder | +| [`--builder`](#builder) | `string` | | Override the configured builder instance | | `-D`, `--debug` | `bool` | | Enable debug logging | -| `-o`, `--output` | `string` | | Output file path | +| [`-o`](#o), [`--output`](#output) | `string` | | Output file path | @@ -23,7 +23,7 @@ Desktop or shared across environments. ## Examples -### Export a single build to a custom file +### Export a single build to a custom file (--output) ```console docker buildx history export qu2gsuo8ejqrwdfii23xkkckt --output mybuild.dockerbuild @@ -35,7 +35,7 @@ You can find build IDs by running: docker buildx history ls ``` -### Export multiple builds to individual `.dockerbuild` files +### Export multiple builds to individual `.dockerbuild` files (-o) To export two builds to separate files: @@ -54,7 +54,7 @@ docker buildx history export ^1 > mybuild.dockerbuild docker buildx history export ^2 > backend-build.dockerbuild ``` -### Export all build records to a file +### Export all build records to a file (--all) Use the `--all` flag and redirect the output: @@ -67,3 +67,15 @@ Or use the `--output` flag: ```console docker buildx history export --all -o all-builds.dockerbuild ``` + +### Use a specific builder instance (--builder) + +```console +docker buildx history export --builder builder0 ^1 -o builder0-build.dockerbuild +``` + +### Enable debug logging (--debug) + +```console +docker buildx history export --debug qu2gsuo8ejqrwdfii23xkkckt -o debug-build.dockerbuild +``` \ No newline at end of file diff --git a/docs/reference/buildx_history_import.md b/docs/reference/buildx_history_import.md index e890b7c1..e269d6ad 100644 --- a/docs/reference/buildx_history_import.md +++ b/docs/reference/buildx_history_import.md @@ -9,7 +9,7 @@ Import a build into Docker Desktop |:----------------|:--------------|:--------|:-----------------------------------------| | `--builder` | `string` | | Override the configured builder instance | | `-D`, `--debug` | `bool` | | Enable debug logging | -| `-f`, `--file` | `stringArray` | | Import from a file path | +| [`-f`](#file), [`--file`](#file) | `stringArray` | | Import from a file path | @@ -22,19 +22,19 @@ pipelines. ## Examples -### Import a `.dockerbuild` archive from standard input +### Import a `.dockerbuild` archive from standard input ```console docker buildx history import < mybuild.dockerbuild ``` -### Import a build archive from a file +### Import a build archive from a file (--file) ```console docker buildx history import --file ./artifacts/backend-build.dockerbuild ``` -### Open a build manually +### Open a build manually By default, the `import` command automatically opens the imported build in Docker Desktop. You don't need to run `open` unless you're opening a specific build diff --git a/docs/reference/buildx_history_inspect.md b/docs/reference/buildx_history_inspect.md index 9246fbdd..942e1a3f 100644 --- a/docs/reference/buildx_history_inspect.md +++ b/docs/reference/buildx_history_inspect.md @@ -29,7 +29,7 @@ provenance, SBOMs, or other detailed information. ## Examples -### Inspect the most recent build +### Inspect the most recent build ```console $ docker buildx history inspect @@ -59,7 +59,7 @@ DIGEST PLATFORM sha256:217329d2af959d4f02e3a96dcbe62bf100cab1feb8006a047ddfe51a5397f7e3 https://slsa.dev/provenance/v0.2 ``` -### Inspect a specific build +### Inspect a specific build ```console # Using a build ID diff --git a/docs/reference/buildx_history_inspect_attachment.md b/docs/reference/buildx_history_inspect_attachment.md index 9377b865..d7f10b63 100644 --- a/docs/reference/buildx_history_inspect_attachment.md +++ b/docs/reference/buildx_history_inspect_attachment.md @@ -10,7 +10,7 @@ Inspect a build attachment | `--builder` | `string` | | Override the configured builder instance | | `-D`, `--debug` | `bool` | | Enable debug logging | | `--platform` | `string` | | Platform of attachment | -| `--type` | `string` | | Type of attachment | +| [`--type`](#type) | `string` | | Type of attachment | @@ -23,7 +23,7 @@ platform-specific. ## Examples -### Inspect a provenance attachment from a build +### Inspect a provenance attachment from a build (--type) Supported types include `provenance` and `sbom`. @@ -45,7 +45,7 @@ $ docker buildx history inspect attachment qu2gsuo8ejqrwdfii23xkkckt --type prov } ``` -### Inspect a SBOM for linux/amd64 +### Inspect a SBOM for linux/amd64 ```console $ docker buildx history inspect attachment ^0 \ @@ -65,7 +65,7 @@ $ docker buildx history inspect attachment ^0 \ } ``` -### Inspect an attachment by digest +### Inspect an attachment by digest You can inspect an attachment directly using its digset, which you can get from the `inspect` output: diff --git a/docs/reference/buildx_history_logs.md b/docs/reference/buildx_history_logs.md index 6785b719..61b9aa4d 100644 --- a/docs/reference/buildx_history_logs.md +++ b/docs/reference/buildx_history_logs.md @@ -9,7 +9,7 @@ Print the logs of a build |:----------------|:---------|:--------|:--------------------------------------------------| | `--builder` | `string` | | Override the configured builder instance | | `-D`, `--debug` | `bool` | | Enable debug logging | -| `--progress` | `string` | `plain` | Set type of progress output (plain, rawjson, tty) | +| [`--progress`](#progress) | `string` | `plain` | Set type of progress output (plain, rawjson, tty) | @@ -28,7 +28,7 @@ You can also specify an earlier build using an offset. For example: ## Examples -### Print logs for the most recent build +### Print logs for the most recent build ```console $ docker buildx history logs @@ -43,7 +43,7 @@ $ docker buildx history logs By default, this shows logs for the most recent build on the current builder. -### Print logs for a specific build +### Print logs for a specific build To print logs for a specific build, use a build ID or offset: @@ -55,7 +55,7 @@ docker buildx history logs qu2gsuo8ejqrwdfii23xkkckt docker buildx history logs ^1 ``` -### Print logs in JSON format +### Set type of progress output (--progress) ```console $ docker buildx history logs ^1 --progress rawjson diff --git a/docs/reference/buildx_history_ls.md b/docs/reference/buildx_history_ls.md index 9277cab5..341a45ba 100644 --- a/docs/reference/buildx_history_ls.md +++ b/docs/reference/buildx_history_ls.md @@ -9,10 +9,10 @@ List build records |:----------------|:--------------|:--------|:---------------------------------------------| | `--builder` | `string` | | Override the configured builder instance | | `-D`, `--debug` | `bool` | | Enable debug logging | -| `--filter` | `stringArray` | | Provide filter values (e.g., `status=error`) | -| `--format` | `string` | `table` | Format the output | -| `--local` | `bool` | | List records for current repository only | -| `--no-trunc` | `bool` | | Don't truncate output | +| [`--filter`](#filter) | `stringArray` | | Provide filter values (e.g., `status=error`) | +| [`--format`](#format) | `string` | `table` | Format the output | +| [`--local`](#local) | `bool` | | List records for current repository only | +| [`--no-trunc`](#no-trunc) | `bool` | | Don't truncate output | @@ -27,7 +27,7 @@ results using flags. ## Examples -### List all build records for the current builder +### List all build records for the current builder ```console $ docker buildx history ls @@ -37,7 +37,7 @@ qsiifiuf1ad9pa9qvppc0z1l3 .dev/2850 Completed 3 days ago 1.3s g9808bwrjrlkbhdamxklx660b .dev/3120 Completed 5 days ago 2.1s ``` -### List only failed builds +### List failed builds (--filter) ```console docker buildx history ls --filter status=error @@ -56,19 +56,21 @@ You can combine multiple filters by repeating the `--filter` flag: docker buildx history ls --filter status=error --filter duration>30s ``` -### List builds from the current project +### List builds from the current project (--local) ```console docker buildx history ls --local ``` -### Display full output without truncation +### Display full output without truncation (--no-trunc) ```console docker buildx history ls --no-trunc ``` -### Format output as JSON +### Format output (--format) + +**JSON output** ```console $ docker buildx history ls --format json @@ -90,7 +92,7 @@ $ docker buildx history ls --format json ] ``` -### Use a Go template to print name and durations +**Go template output** ```console $ docker buildx history ls --format '{{.Name}} - {{.Duration}}' diff --git a/docs/reference/buildx_history_open.md b/docs/reference/buildx_history_open.md index b9ed6f81..e0817b41 100644 --- a/docs/reference/buildx_history_open.md +++ b/docs/reference/buildx_history_open.md @@ -20,7 +20,7 @@ Docker Desktop to be installed and running on the host machine. ## Examples -### Open the most recent build in Docker Desktop +### Open the most recent build in Docker Desktop ```console docker buildx history open @@ -28,7 +28,7 @@ docker buildx history open By default, this opens the most recent build on the current builder. -### Open a specific build +### Open a specific build ```console # Using a build ID diff --git a/docs/reference/buildx_history_rm.md b/docs/reference/buildx_history_rm.md index e7bbd1d8..dedf1a0c 100644 --- a/docs/reference/buildx_history_rm.md +++ b/docs/reference/buildx_history_rm.md @@ -22,7 +22,7 @@ the `--all` flag. ## Examples -### Remove a specific build +### Remove a specific build ```console # Using a build ID @@ -32,7 +32,7 @@ docker buildx history rm qu2gsuo8ejqrwdfii23xkkckt docker buildx history rm ^1 ``` -### Remove multiple builds +### Remove multiple builds ```console # Using build IDs @@ -42,7 +42,7 @@ docker buildx history rm qu2gsuo8ejqrwdfii23xkkckt qsiifiuf1ad9pa9qvppc0z1l3 docker buildx history rm ^1 ^2 ``` -### Remove all build records from the current builder +### Remove all build records from the current builder ```console docker buildx history rm --all diff --git a/docs/reference/buildx_history_trace.md b/docs/reference/buildx_history_trace.md index f9b45e21..19912f44 100644 --- a/docs/reference/buildx_history_trace.md +++ b/docs/reference/buildx_history_trace.md @@ -7,9 +7,9 @@ Show the OpenTelemetry trace of a build record | Name | Type | Default | Description | |:----------------|:---------|:--------------|:-----------------------------------------| -| `--addr` | `string` | `127.0.0.1:0` | Address to bind the UI server | +| [`--addr`](#addr) | `string` | `127.0.0.1:0` | Address to bind the UI server | | `--builder` | `string` | | Override the configured builder instance | -| `--compare` | `string` | | Compare with another build reference | +| [`--compare`](#compare) | `string` | | Compare with another build reference | | `-D`, `--debug` | `bool` | | Enable debug logging | @@ -24,7 +24,7 @@ This helps analyze build performance, step timing, and internal execution flows. ## Examples -### Open the OpenTelemetry trace for the most recent build +### Open the OpenTelemetry trace for the most recent build This command starts a temporary Jaeger UI server and opens your default browser to view the trace. @@ -33,7 +33,7 @@ to view the trace. docker buildx history trace ``` -### Open the trace for a specific build +### Open the trace for a specific build ```console # Using a build ID @@ -43,7 +43,7 @@ docker buildx history trace qu2gsuo8ejqrwdfii23xkkckt docker buildx history trace ^1 ``` -### Run the Jaeger UI on a specific port +### Run the Jaeger UI on a specific port (--addr) ```console # Using a build ID @@ -53,7 +53,7 @@ docker buildx history trace qu2gsuo8ejqrwdfii23xkkckt --addr 127.0.0.1:16686 docker buildx history trace ^1 --addr 127.0.0.1:16686 ``` -### Compare two build traces +### Compare two build traces (--compare) Compare two specific builds by name: