docker/buildx
1
0
Fork 0
mirror of https://gitea.com/Lydanne/buildx.git synced 2025-07-09 21:17:09 +08:00
Code Issues Packages Projects Releases 1 Wiki Activity

docs: use "examples" section, and rephrase headings

Browse Source 
Put the flag descriptions/examples under an "examples"
section (used at docs.docker.com), and rephrase the
headings to be more consistent with other pages in the
docker documentation.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn
2021-01-13 16:37:15 +01:00
parent 87ec3af5bb
commit 442d38080e
5 changed files with 187 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/reference/buildx_inspect.md
View File

@ -14,7 +14,14 @@ Options:
Shows information about the current or specified builder.
Example:
## Examples
### Get information about a builder instance
By default, `inspect` shows information about the current builder. Specify the
name of the builder to inspect to get information about that builder.
The following example shows information about a builder instance named
`elated_tesla`:
```console
$ docker buildx inspect elated_tesla
@ -34,10 +41,11 @@ Status: running
Platforms: linux/arm64, linux/arm/v7, linux/arm/v6
```
### `--bootstrap`
### Ensure that the builder is running before inspecting (--bootstrap)
Ensures that the builder is running before inspecting it. If the driver is
`docker-container`, then `--bootstrap` starts the buildkit container and waits
until it is operational. Bootstrapping is automatically done during build, it is
thus not necessary. The same BuildKit container is used during the lifetime of
the associated builder node (as displayed in `buildx ls`).
Use the `--bootstrap` option to ensures that the builder is running before
inspecting it. If the driver is `docker-container`, then `--bootstrap` starts
the buildkit container and waits until it is operational. Bootstrapping is
automatically done during build, it is thus not necessary. The same BuildKit
container is used during the lifetime of the associated builder node (as
displayed in `buildx ls`).