From 8397072c23f1592fecbbf3bba25431f3b6f0508f Mon Sep 17 00:00:00 2001 From: Viacheslav Vasilyev Date: Thu, 3 Oct 2024 10:45:42 +0100 Subject: [PATCH] renew docs Signed-off-by: Viacheslav Vasilyev --- docs/reference/buildx.md | 9 ++++---- docs/reference/buildx_bake.md | 1 + docs/reference/buildx_build.md | 1 + docs/reference/buildx_create.md | 1 + docs/reference/buildx_debug.md | 15 +++++++------- docs/reference/buildx_debug_build.md | 1 + docs/reference/buildx_dial-stdio.md | 13 ++++++------ docs/reference/buildx_du.md | 13 ++++++------ docs/reference/buildx_imagetools.md | 9 ++++---- docs/reference/buildx_imagetools_create.md | 1 + docs/reference/buildx_imagetools_inspect.md | 13 ++++++------ docs/reference/buildx_inspect.md | 11 +++++----- docs/reference/buildx_ls.md | 11 +++++----- docs/reference/buildx_prune.md | 23 +++++++++++---------- docs/reference/buildx_rm.md | 17 ++++++++------- docs/reference/buildx_stop.md | 9 ++++---- docs/reference/buildx_use.md | 13 ++++++------ docs/reference/buildx_version.md | 7 ++++--- 18 files changed, 93 insertions(+), 75 deletions(-) diff --git a/docs/reference/buildx.md b/docs/reference/buildx.md index 6e060ce5..fd00ee0f 100644 --- a/docs/reference/buildx.md +++ b/docs/reference/buildx.md @@ -30,10 +30,11 @@ Extended build capabilities with BuildKit ### Options -| Name | Type | Default | Description | -|:------------------------|:---------|:--------|:-----------------------------------------| -| [`--builder`](#builder) | `string` | | Override the configured builder instance | -| `-D`, `--debug` | `bool` | | Enable debug logging | +| Name | Type | Default | Description | +|:------------------------|:-----------|:--------|:---------------------------------------------------------------------| +| [`--builder`](#builder) | `string` | | Override the configured builder instance | +| `-D`, `--debug` | `bool` | | Enable debug logging | +| `--timeout` | `duration` | `20s` | Override the default global timeout (as duration, for example 1m20s) | diff --git a/docs/reference/buildx_bake.md b/docs/reference/buildx_bake.md index 733a3eae..eca0d76a 100644 --- a/docs/reference/buildx_bake.md +++ b/docs/reference/buildx_bake.md @@ -32,6 +32,7 @@ Build from a file | `--push` | `bool` | | Shorthand for `--set=*.output=type=registry` | | [`--sbom`](#sbom) | `string` | | Shorthand for `--set=*.attest=type=sbom` | | [`--set`](#set) | `stringArray` | | Override target value (e.g., `targetpattern.key=value`) | +| `--timeout` | `duration` | `20s` | Override the default global timeout (as duration, for example 1m20s) | diff --git a/docs/reference/buildx_build.md b/docs/reference/buildx_build.md index e9de2927..9d9feb53 100644 --- a/docs/reference/buildx_build.md +++ b/docs/reference/buildx_build.md @@ -49,6 +49,7 @@ Start a build | [`--ssh`](#ssh) | `stringArray` | | SSH agent socket or keys to expose to the build (format: `default\|[=\|[,]]`) | | [`-t`](#tag), [`--tag`](#tag) | `stringArray` | | Name and optionally a tag (format: `name:tag`) | | [`--target`](#target) | `string` | | Set the target build stage to build | +| `--timeout` | `duration` | `20s` | Override the default global timeout (as duration, for example 1m20s) | | [`--ulimit`](#ulimit) | `ulimit` | | Ulimit options | diff --git a/docs/reference/buildx_create.md b/docs/reference/buildx_create.md index 96d71b29..0ae56eda 100644 --- a/docs/reference/buildx_create.md +++ b/docs/reference/buildx_create.md @@ -22,6 +22,7 @@ Create a new builder instance | [`--name`](#name) | `string` | | Builder instance name | | [`--node`](#node) | `string` | | Create/modify node with given name | | [`--platform`](#platform) | `stringArray` | | Fixed platforms for current node | +| `--timeout` | `duration` | `20s` | Override the default global timeout (as duration, for example 1m20s) | | [`--use`](#use) | `bool` | | Set the current builder instance | diff --git a/docs/reference/buildx_debug.md b/docs/reference/buildx_debug.md index afe69567..e2afdd5b 100644 --- a/docs/reference/buildx_debug.md +++ b/docs/reference/buildx_debug.md @@ -12,13 +12,14 @@ Start debugger (EXPERIMENTAL) ### Options -| Name | Type | Default | Description | -|:----------------|:---------|:--------|:--------------------------------------------------------------------------------------------------------------------| -| `--builder` | `string` | | Override the configured builder instance | -| `-D`, `--debug` | `bool` | | Enable debug logging | -| `--invoke` | `string` | | Launch a monitor with executing specified command (EXPERIMENTAL) | -| `--on` | `string` | `error` | When to launch the monitor ([always, error]) (EXPERIMENTAL) | -| `--progress` | `string` | `auto` | Set type of progress output (`auto`, `plain`, `tty`, `rawjson`) for the monitor. Use plain to show container output | +| Name | Type | Default | Description | +|:----------------|:-----------|:--------|:--------------------------------------------------------------------------------------------------------------------| +| `--builder` | `string` | | Override the configured builder instance | +| `-D`, `--debug` | `bool` | | Enable debug logging | +| `--invoke` | `string` | | Launch a monitor with executing specified command (EXPERIMENTAL) | +| `--on` | `string` | `error` | When to launch the monitor ([always, error]) (EXPERIMENTAL) | +| `--progress` | `string` | `auto` | Set type of progress output (`auto`, `plain`, `tty`, `rawjson`) for the monitor. Use plain to show container output | +| `--timeout` | `duration` | `20s` | Override the default global timeout (as duration, for example 1m20s) | diff --git a/docs/reference/buildx_debug_build.md b/docs/reference/buildx_debug_build.md index ee359480..5b0c459c 100644 --- a/docs/reference/buildx_debug_build.md +++ b/docs/reference/buildx_debug_build.md @@ -45,6 +45,7 @@ Start a build | `--ssh` | `stringArray` | | SSH agent socket or keys to expose to the build (format: `default\|[=\|[,]]`) | | `-t`, `--tag` | `stringArray` | | Name and optionally a tag (format: `name:tag`) | | `--target` | `string` | | Set the target build stage to build | +| `--timeout` | `duration` | `20s` | Override the default global timeout (as duration, for example 1m20s) | | `--ulimit` | `ulimit` | | Ulimit options | diff --git a/docs/reference/buildx_dial-stdio.md b/docs/reference/buildx_dial-stdio.md index 7fdc84ec..fb951c23 100644 --- a/docs/reference/buildx_dial-stdio.md +++ b/docs/reference/buildx_dial-stdio.md @@ -5,12 +5,13 @@ Proxy current stdio streams to builder instance ### Options -| Name | Type | Default | Description | -|:----------------|:---------|:--------|:----------------------------------------------------------------------------------------------------| -| `--builder` | `string` | | Override the configured builder instance | -| `-D`, `--debug` | `bool` | | Enable debug logging | -| `--platform` | `string` | | Target platform: this is used for node selection | -| `--progress` | `string` | `quiet` | Set type of progress output (`auto`, `plain`, `tty`, `rawjson`). Use plain to show container output | +| Name | Type | Default | Description | +|:----------------|:-----------|:--------|:----------------------------------------------------------------------------------------------------| +| `--builder` | `string` | | Override the configured builder instance | +| `-D`, `--debug` | `bool` | | Enable debug logging | +| `--platform` | `string` | | Target platform: this is used for node selection | +| `--progress` | `string` | `quiet` | Set type of progress output (`auto`, `plain`, `tty`, `rawjson`). Use plain to show container output | +| `--timeout` | `duration` | `20s` | Override the default global timeout (as duration, for example 1m20s) | diff --git a/docs/reference/buildx_du.md b/docs/reference/buildx_du.md index 684f717a..3922fd21 100644 --- a/docs/reference/buildx_du.md +++ b/docs/reference/buildx_du.md @@ -9,12 +9,13 @@ Disk usage ### Options -| Name | Type | Default | Description | -|:------------------------|:---------|:--------|:-----------------------------------------| -| [`--builder`](#builder) | `string` | | Override the configured builder instance | -| `-D`, `--debug` | `bool` | | Enable debug logging | -| `--filter` | `filter` | | Provide filter values | -| [`--verbose`](#verbose) | `bool` | | Provide a more verbose output | +| Name | Type | Default | Description | +|:------------------------|:-----------|:--------|:---------------------------------------------------------------------| +| [`--builder`](#builder) | `string` | | Override the configured builder instance | +| `-D`, `--debug` | `bool` | | Enable debug logging | +| `--filter` | `filter` | | Provide filter values | +| `--timeout` | `duration` | `20s` | Override the default global timeout (as duration, for example 1m20s) | +| [`--verbose`](#verbose) | `bool` | | Provide a more verbose output | diff --git a/docs/reference/buildx_imagetools.md b/docs/reference/buildx_imagetools.md index 42e191dd..9151533e 100644 --- a/docs/reference/buildx_imagetools.md +++ b/docs/reference/buildx_imagetools.md @@ -17,10 +17,11 @@ Commands to work on images in registry ### Options -| Name | Type | Default | Description | -|:------------------------|:---------|:--------|:-----------------------------------------| -| [`--builder`](#builder) | `string` | | Override the configured builder instance | -| `-D`, `--debug` | `bool` | | Enable debug logging | +| Name | Type | Default | Description | +|:------------------------|:-----------|:--------|:---------------------------------------------------------------------| +| [`--builder`](#builder) | `string` | | Override the configured builder instance | +| `-D`, `--debug` | `bool` | | Enable debug logging | +| `--timeout` | `duration` | `20s` | Override the default global timeout (as duration, for example 1m20s) | diff --git a/docs/reference/buildx_imagetools_create.md b/docs/reference/buildx_imagetools_create.md index d937d5d7..098a2d45 100644 --- a/docs/reference/buildx_imagetools_create.md +++ b/docs/reference/buildx_imagetools_create.md @@ -20,6 +20,7 @@ Create a new image based on source images | `--prefer-index` | `bool` | `true` | When only a single source is specified, prefer outputting an image index or manifest list instead of performing a carbon copy | | `--progress` | `string` | `auto` | Set type of progress output (`auto`, `plain`, `tty`, `rawjson`). Use plain to show container output | | [`-t`](#tag), [`--tag`](#tag) | `stringArray` | | Set reference for new image | +| `--timeout` | `duration` | `20s` | Override the default global timeout (as duration, for example 1m20s) | diff --git a/docs/reference/buildx_imagetools_inspect.md b/docs/reference/buildx_imagetools_inspect.md index ed98215b..2dc2e2c3 100644 --- a/docs/reference/buildx_imagetools_inspect.md +++ b/docs/reference/buildx_imagetools_inspect.md @@ -9,12 +9,13 @@ Show details of an image in the registry ### Options -| Name | Type | Default | Description | -|:------------------------|:---------|:----------------|:----------------------------------------------| -| [`--builder`](#builder) | `string` | | Override the configured builder instance | -| `-D`, `--debug` | `bool` | | Enable debug logging | -| [`--format`](#format) | `string` | `{{.Manifest}}` | Format the output using the given Go template | -| [`--raw`](#raw) | `bool` | | Show original, unformatted JSON manifest | +| Name | Type | Default | Description | +|:------------------------|:-----------|:----------------|:---------------------------------------------------------------------| +| [`--builder`](#builder) | `string` | | Override the configured builder instance | +| `-D`, `--debug` | `bool` | | Enable debug logging | +| [`--format`](#format) | `string` | `{{.Manifest}}` | Format the output using the given Go template | +| [`--raw`](#raw) | `bool` | | Show original, unformatted JSON manifest | +| `--timeout` | `duration` | `20s` | Override the default global timeout (as duration, for example 1m20s) | diff --git a/docs/reference/buildx_inspect.md b/docs/reference/buildx_inspect.md index 02847e87..6a53cc7d 100644 --- a/docs/reference/buildx_inspect.md +++ b/docs/reference/buildx_inspect.md @@ -9,11 +9,12 @@ Inspect current builder instance ### Options -| Name | Type | Default | Description | -|:----------------------------|:---------|:--------|:--------------------------------------------| -| [`--bootstrap`](#bootstrap) | `bool` | | Ensure builder has booted before inspecting | -| [`--builder`](#builder) | `string` | | Override the configured builder instance | -| `-D`, `--debug` | `bool` | | Enable debug logging | +| Name | Type | Default | Description | +|:----------------------------|:-----------|:--------|:---------------------------------------------------------------------| +| [`--bootstrap`](#bootstrap) | `bool` | | Ensure builder has booted before inspecting | +| [`--builder`](#builder) | `string` | | Override the configured builder instance | +| `-D`, `--debug` | `bool` | | Enable debug logging | +| `--timeout` | `duration` | `20s` | Override the default global timeout (as duration, for example 1m20s) | diff --git a/docs/reference/buildx_ls.md b/docs/reference/buildx_ls.md index 63f442f2..4547ed70 100644 --- a/docs/reference/buildx_ls.md +++ b/docs/reference/buildx_ls.md @@ -9,11 +9,12 @@ List builder instances ### Options -| Name | Type | Default | Description | -|:----------------------|:---------|:--------|:----------------------| -| `-D`, `--debug` | `bool` | | Enable debug logging | -| [`--format`](#format) | `string` | `table` | Format the output | -| `--no-trunc` | `bool` | | Don't truncate output | +| Name | Type | Default | Description | +|:----------------------|:-----------|:--------|:---------------------------------------------------------------------| +| `-D`, `--debug` | `bool` | | Enable debug logging | +| [`--format`](#format) | `string` | `table` | Format the output | +| `--no-trunc` | `bool` | | Don't truncate output | +| `--timeout` | `duration` | `20s` | Override the default global timeout (as duration, for example 1m20s) | diff --git a/docs/reference/buildx_prune.md b/docs/reference/buildx_prune.md index e86b3021..fca5bee9 100644 --- a/docs/reference/buildx_prune.md +++ b/docs/reference/buildx_prune.md @@ -9,17 +9,18 @@ Remove build cache ### Options -| Name | Type | Default | Description | -|:------------------------|:---------|:--------|:-------------------------------------------------------| -| `-a`, `--all` | `bool` | | Include internal/frontend images | -| [`--builder`](#builder) | `string` | | Override the configured builder instance | -| `-D`, `--debug` | `bool` | | Enable debug logging | -| `--filter` | `filter` | | Provide filter values (e.g., `until=24h`) | -| `-f`, `--force` | `bool` | | Do not prompt for confirmation | -| `--max-used-space` | `bytes` | `0` | Maximum amount of disk space allowed to keep for cache | -| `--min-free-space` | `bytes` | `0` | Target amount of free disk space after pruning | -| `--reserved-space` | `bytes` | `0` | Amount of disk space always allowed to keep for cache | -| `--verbose` | `bool` | | Provide a more verbose output | +| Name | Type | Default | Description | +|:------------------------|:-----------|:--------|:---------------------------------------------------------------------| +| `-a`, `--all` | `bool` | | Include internal/frontend images | +| [`--builder`](#builder) | `string` | | Override the configured builder instance | +| `-D`, `--debug` | `bool` | | Enable debug logging | +| `--filter` | `filter` | | Provide filter values (e.g., `until=24h`) | +| `-f`, `--force` | `bool` | | Do not prompt for confirmation | +| `--max-used-space` | `bytes` | `0` | Maximum amount of disk space allowed to keep for cache | +| `--min-free-space` | `bytes` | `0` | Target amount of free disk space after pruning | +| `--reserved-space` | `bytes` | `0` | Amount of disk space always allowed to keep for cache | +| `--timeout` | `duration` | `20s` | Override the default global timeout (as duration, for example 1m20s) | +| `--verbose` | `bool` | | Provide a more verbose output | diff --git a/docs/reference/buildx_rm.md b/docs/reference/buildx_rm.md index bcb856e7..795f1efe 100644 --- a/docs/reference/buildx_rm.md +++ b/docs/reference/buildx_rm.md @@ -9,14 +9,15 @@ Remove one or more builder instances ### Options -| Name | Type | Default | Description | -|:------------------------------------|:---------|:--------|:-----------------------------------------| -| [`--all-inactive`](#all-inactive) | `bool` | | Remove all inactive builders | -| [`--builder`](#builder) | `string` | | Override the configured builder instance | -| `-D`, `--debug` | `bool` | | Enable debug logging | -| [`-f`](#force), [`--force`](#force) | `bool` | | Do not prompt for confirmation | -| [`--keep-daemon`](#keep-daemon) | `bool` | | Keep the BuildKit daemon running | -| [`--keep-state`](#keep-state) | `bool` | | Keep BuildKit state | +| Name | Type | Default | Description | +|:------------------------------------|:-----------|:--------|:---------------------------------------------------------------------| +| [`--all-inactive`](#all-inactive) | `bool` | | Remove all inactive builders | +| [`--builder`](#builder) | `string` | | Override the configured builder instance | +| `-D`, `--debug` | `bool` | | Enable debug logging | +| [`-f`](#force), [`--force`](#force) | `bool` | | Do not prompt for confirmation | +| [`--keep-daemon`](#keep-daemon) | `bool` | | Keep the BuildKit daemon running | +| [`--keep-state`](#keep-state) | `bool` | | Keep BuildKit state | +| `--timeout` | `duration` | `20s` | Override the default global timeout (as duration, for example 1m20s) | diff --git a/docs/reference/buildx_stop.md b/docs/reference/buildx_stop.md index dcf0430a..1cddab58 100644 --- a/docs/reference/buildx_stop.md +++ b/docs/reference/buildx_stop.md @@ -9,10 +9,11 @@ Stop builder instance ### Options -| Name | Type | Default | Description | -|:------------------------|:---------|:--------|:-----------------------------------------| -| [`--builder`](#builder) | `string` | | Override the configured builder instance | -| `-D`, `--debug` | `bool` | | Enable debug logging | +| Name | Type | Default | Description | +|:------------------------|:-----------|:--------|:---------------------------------------------------------------------| +| [`--builder`](#builder) | `string` | | Override the configured builder instance | +| `-D`, `--debug` | `bool` | | Enable debug logging | +| `--timeout` | `duration` | `20s` | Override the default global timeout (as duration, for example 1m20s) | diff --git a/docs/reference/buildx_use.md b/docs/reference/buildx_use.md index 6cd1652f..9137aa89 100644 --- a/docs/reference/buildx_use.md +++ b/docs/reference/buildx_use.md @@ -9,12 +9,13 @@ Set the current builder instance ### Options -| Name | Type | Default | Description | -|:------------------------|:---------|:--------|:-------------------------------------------| -| [`--builder`](#builder) | `string` | | Override the configured builder instance | -| `-D`, `--debug` | `bool` | | Enable debug logging | -| `--default` | `bool` | | Set builder as default for current context | -| `--global` | `bool` | | Builder persists context changes | +| Name | Type | Default | Description | +|:------------------------|:-----------|:--------|:---------------------------------------------------------------------| +| [`--builder`](#builder) | `string` | | Override the configured builder instance | +| `-D`, `--debug` | `bool` | | Enable debug logging | +| `--default` | `bool` | | Set builder as default for current context | +| `--global` | `bool` | | Builder persists context changes | +| `--timeout` | `duration` | `20s` | Override the default global timeout (as duration, for example 1m20s) | diff --git a/docs/reference/buildx_version.md b/docs/reference/buildx_version.md index e186812f..13b41712 100644 --- a/docs/reference/buildx_version.md +++ b/docs/reference/buildx_version.md @@ -9,9 +9,10 @@ Show buildx version information ### Options -| Name | Type | Default | Description | -|:----------------|:-------|:--------|:---------------------| -| `-D`, `--debug` | `bool` | | Enable debug logging | +| Name | Type | Default | Description | +|:----------------|:-----------|:--------|:---------------------------------------------------------------------| +| `-D`, `--debug` | `bool` | | Enable debug logging | +| `--timeout` | `duration` | `20s` | Override the default global timeout (as duration, for example 1m20s) |