From 94c5dde85a8ea6a808aaae0da649425b3180283e Mon Sep 17 00:00:00 2001 From: CrazyMax Date: Sat, 26 Feb 2022 05:39:42 +0100 Subject: [PATCH] docs: small fixes Signed-off-by: CrazyMax --- README.md | 2 +- commands/build.go | 2 +- docs/reference/buildx_bake.md | 2 +- docs/reference/buildx_build.md | 17 +++-------------- 4 files changed, 6 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index ee439a3c..1680a6eb 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,7 @@ Rename the relevant binary and copy it to the destination matching your OS: | -------- | -------------------- | -----------------------------------------| | Linux | `docker-buildx` | `$HOME/.docker/cli-plugins` | | macOS | `docker-buildx` | `$HOME/.docker/cli-plugins` | -| Windows | `docker-buildx.exe` | `%USERPROFILE%\.docker\cli-plugin` | +| Windows | `docker-buildx.exe` | `%USERPROFILE%\.docker\cli-plugins` | Or copy it into one of these folders for installing it system-wide. diff --git a/commands/build.go b/commands/build.go index f63214b4..70a745b4 100644 --- a/commands/build.go +++ b/commands/build.go @@ -444,7 +444,7 @@ func buildCmd(dockerCli command.Cli, rootOpts *rootOptions) *cobra.Command { func commonBuildFlags(options *commonOptions, flags *pflag.FlagSet) { options.noCache = flags.Bool("no-cache", false, "Do not use cache when building the image") flags.StringVar(&options.progress, "progress", "auto", `Set type of progress output ("auto", "plain", "tty"). Use plain to show container output`) - options.pull = flags.Bool("pull", false, "Always attempt to pull a newer version of the image") + options.pull = flags.Bool("pull", false, "Always attempt to pull all referenced images") flags.StringVar(&options.metadataFile, "metadata-file", "", "Write build result metadata to the file") } diff --git a/docs/reference/buildx_bake.md b/docs/reference/buildx_bake.md index 2eef58fd..938754ab 100644 --- a/docs/reference/buildx_bake.md +++ b/docs/reference/buildx_bake.md @@ -22,7 +22,7 @@ Build from a file | [`--no-cache`](#no-cache) | | | Do not use cache when building the image | | [`--print`](#print) | | | Print the options without building | | [`--progress`](#progress) | `string` | `auto` | Set type of progress output (`auto`, `plain`, `tty`). Use plain to show container output | -| [`--pull`](#pull) | | | Always attempt to pull a newer version of the image | +| [`--pull`](#pull) | | | Always attempt to pull all referenced images | | `--push` | | | Shorthand for `--set=*.output=type=registry` | | [`--set`](#set) | `stringArray` | | Override target value (e.g., `targetpattern.key=value`) | diff --git a/docs/reference/buildx_build.md b/docs/reference/buildx_build.md index 2a8339d3..ff89f0fa 100644 --- a/docs/reference/buildx_build.md +++ b/docs/reference/buildx_build.md @@ -34,7 +34,7 @@ Start a build | [`-o`](#output), [`--output`](#output) | `stringArray` | | Output destination (format: `type=local,dest=path`) | | [`--platform`](#platform) | `stringArray` | | Set target platform for build | | [`--progress`](#progress) | `string` | `auto` | Set type of progress output (`auto`, `plain`, `tty`). Use plain to show container output | -| `--pull` | | | Always attempt to pull a newer version of the image | +| `--pull` | | | Always attempt to pull all referenced images | | [`--push`](#push) | | | Shorthand for `--output=type=registry` | | `-q`, `--quiet` | | | Suppress the build output and print image ID on success | | [`--secret`](#secret) | `stringArray` | | Secret to expose to the build (format: `id=mysecret[,src=/local/secret]`) | @@ -54,19 +54,7 @@ to the UI of `docker build` command and takes the same flags and arguments. For documentation on most of these flags, refer to the [`docker build` documentation](https://docs.docker.com/engine/reference/commandline/build/). In -here we’ll document a subset of the new flags. - -### Built-in build args - -* `BUILDKIT_INLINE_BUILDINFO_ATTRS=` inline build info attributes in image config or not -* `BUILDKIT_INLINE_CACHE=` inline cache metadata to image config or not -* `BUILDKIT_MULTI_PLATFORM=` opt into determnistic output regardless of multi-platform output or not - -```shell -docker buildx build --build-arg BUILDKIT_MULTI_PLATFORM=1 . -``` - -Other useful built-in args can be found in [dockerfile frontend docs](https://github.com/moby/buildkit/blob/master/frontend/dockerfile/docs/syntax.md#built-in-build-args). +here we'll document a subset of the new flags. ## Examples @@ -99,6 +87,7 @@ Same as [`docker build` command](https://docs.docker.com/engine/reference/comman There are also useful built-in build args like: * `BUILDKIT_CONTEXT_KEEP_GIT_DIR=` trigger git context to keep the `.git` directory +* `BUILDKIT_INLINE_BUILDINFO_ATTRS=` inline build info attributes in image config or not * `BUILDKIT_INLINE_CACHE=` inline cache metadata to image config or not * `BUILDKIT_MULTI_PLATFORM=` opt into determnistic output regardless of multi-platform output or not