From e1e8f5c68d0360df3d717293ddc54294891e41e7 Mon Sep 17 00:00:00 2001 From: Tonis Tiigi Date: Mon, 5 May 2025 14:31:35 -0700 Subject: [PATCH] docs: updated reference docs generation Signed-off-by: Tonis Tiigi --- docs/reference/buildx_history_export.md | 12 ++++++------ docs/reference/buildx_history_import.md | 10 +++++----- .../reference/buildx_history_inspect_attachment.md | 12 ++++++------ docs/reference/buildx_history_logs.md | 8 ++++---- docs/reference/buildx_history_ls.md | 14 +++++++------- docs/reference/buildx_history_trace.md | 12 ++++++------ 6 files changed, 34 insertions(+), 34 deletions(-) diff --git a/docs/reference/buildx_history_export.md b/docs/reference/buildx_history_export.md index 1b223798..ab8a1ff8 100644 --- a/docs/reference/buildx_history_export.md +++ b/docs/reference/buildx_history_export.md @@ -5,12 +5,12 @@ Export a build into Docker Desktop bundle ### Options -| Name | Type | Default | Description | -|:-----------------|:---------|:--------|:-----------------------------------------| -| [`--all`](#all) | `bool` | | Export all records for the builder | -| [`--builder`](#builder) | `string` | | Override the configured builder instance | -| `-D`, `--debug` | `bool` | | Enable debug logging | -| [`-o`](#o), [`--output`](#output) | `string` | | Output file path | +| Name | Type | Default | Description | +|:---------------------------------------|:---------|:--------|:-----------------------------------------| +| [`--all`](#all) | `bool` | | Export all records for the builder | +| [`--builder`](#builder) | `string` | | Override the configured builder instance | +| [`-D`](#debug), [`--debug`](#debug) | `bool` | | Enable debug logging | +| [`-o`](#output), [`--output`](#output) | `string` | | Output file path | diff --git a/docs/reference/buildx_history_import.md b/docs/reference/buildx_history_import.md index e269d6ad..cc145ea0 100644 --- a/docs/reference/buildx_history_import.md +++ b/docs/reference/buildx_history_import.md @@ -5,11 +5,11 @@ Import a build into Docker Desktop ### Options -| Name | Type | Default | Description | -|:----------------|:--------------|:--------|:-----------------------------------------| -| `--builder` | `string` | | Override the configured builder instance | -| `-D`, `--debug` | `bool` | | Enable debug logging | -| [`-f`](#file), [`--file`](#file) | `stringArray` | | Import from a file path | +| Name | Type | Default | Description | +|:---------------------------------|:--------------|:--------|:-----------------------------------------| +| `--builder` | `string` | | Override the configured builder instance | +| `-D`, `--debug` | `bool` | | Enable debug logging | +| [`-f`](#file), [`--file`](#file) | `stringArray` | | Import from a file path | diff --git a/docs/reference/buildx_history_inspect_attachment.md b/docs/reference/buildx_history_inspect_attachment.md index d7f10b63..6014e924 100644 --- a/docs/reference/buildx_history_inspect_attachment.md +++ b/docs/reference/buildx_history_inspect_attachment.md @@ -5,12 +5,12 @@ Inspect a build attachment ### Options -| Name | Type | Default | Description | -|:----------------|:---------|:--------|:-----------------------------------------| -| `--builder` | `string` | | Override the configured builder instance | -| `-D`, `--debug` | `bool` | | Enable debug logging | -| `--platform` | `string` | | Platform of attachment | -| [`--type`](#type) | `string` | | Type of attachment | +| Name | Type | Default | Description | +|:------------------|:---------|:--------|:-----------------------------------------| +| `--builder` | `string` | | Override the configured builder instance | +| `-D`, `--debug` | `bool` | | Enable debug logging | +| `--platform` | `string` | | Platform of attachment | +| [`--type`](#type) | `string` | | Type of attachment | diff --git a/docs/reference/buildx_history_logs.md b/docs/reference/buildx_history_logs.md index 61b9aa4d..212b43cc 100644 --- a/docs/reference/buildx_history_logs.md +++ b/docs/reference/buildx_history_logs.md @@ -5,10 +5,10 @@ Print the logs of a build ### Options -| Name | Type | Default | Description | -|:----------------|:---------|:--------|:--------------------------------------------------| -| `--builder` | `string` | | Override the configured builder instance | -| `-D`, `--debug` | `bool` | | Enable debug logging | +| Name | Type | Default | Description | +|:--------------------------|:---------|:--------|:--------------------------------------------------| +| `--builder` | `string` | | Override the configured builder instance | +| `-D`, `--debug` | `bool` | | Enable debug logging | | [`--progress`](#progress) | `string` | `plain` | Set type of progress output (plain, rawjson, tty) | diff --git a/docs/reference/buildx_history_ls.md b/docs/reference/buildx_history_ls.md index 341a45ba..88a7ce34 100644 --- a/docs/reference/buildx_history_ls.md +++ b/docs/reference/buildx_history_ls.md @@ -5,14 +5,14 @@ List build records ### Options -| Name | Type | Default | Description | -|:----------------|:--------------|:--------|:---------------------------------------------| -| `--builder` | `string` | | Override the configured builder instance | -| `-D`, `--debug` | `bool` | | Enable debug logging | -| [`--filter`](#filter) | `stringArray` | | Provide filter values (e.g., `status=error`) | -| [`--format`](#format) | `string` | `table` | Format the output | +| Name | Type | Default | Description | +|:--------------------------|:--------------|:--------|:---------------------------------------------| +| `--builder` | `string` | | Override the configured builder instance | +| `-D`, `--debug` | `bool` | | Enable debug logging | +| [`--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 | +| [`--no-trunc`](#no-trunc) | `bool` | | Don't truncate output | diff --git a/docs/reference/buildx_history_trace.md b/docs/reference/buildx_history_trace.md index 19912f44..2b448145 100644 --- a/docs/reference/buildx_history_trace.md +++ b/docs/reference/buildx_history_trace.md @@ -5,12 +5,12 @@ Show the OpenTelemetry trace of a build record ### Options -| Name | Type | Default | Description | -|:----------------|:---------|:--------------|:-----------------------------------------| -| [`--addr`](#addr) | `string` | `127.0.0.1:0` | Address to bind the UI server | -| `--builder` | `string` | | Override the configured builder instance | -| [`--compare`](#compare) | `string` | | Compare with another build reference | -| `-D`, `--debug` | `bool` | | Enable debug logging | +| Name | Type | Default | Description | +|:------------------------|:---------|:--------------|:-----------------------------------------| +| [`--addr`](#addr) | `string` | `127.0.0.1:0` | Address to bind the UI server | +| `--builder` | `string` | | Override the configured builder instance | +| [`--compare`](#compare) | `string` | | Compare with another build reference | +| `-D`, `--debug` | `bool` | | Enable debug logging |