Skip to content

Commit

Permalink
Merge pull request #3580 from jayaddison/docs/buildah-build-platform
Browse files Browse the repository at this point in the history
docs: update buildah-build 'platform' option compatibility notes
  • Loading branch information
openshift-merge-robot committed Oct 11, 2021
2 parents 50869a7 + f795888 commit 47c78dd
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions docs/buildah-build.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -415,9 +415,7 @@ process.

Set the OS/ARCH of the built image (and its base image, if your build uses one)
to the provided value instead of using the current operating system and
architecture of the host (for example `linux/arm`). If `--platform` is set,
then the values of the `--arch`, `--os`, and `--variant` options will be
overridden.
architecture of the host (for example `linux/arm`).

The `--platform` flag can be specified more than once, or given a
comma-separated list of values as its argument. When more than one platform is
Expand All @@ -434,6 +432,8 @@ While `buildah bud` is happy to use base images and build images for any
platform that exists, `RUN` instructions will not be able to succeed without
the help of emulation provided by packages like `qemu-user-static`.

**NOTE:** The `--platform` option may not be used in combination with the `--arch`, `--os`, or `--variant` options.

**--pull**

When the flag is enabled, attempt to pull the latest image from the registries
Expand Down
6 changes: 3 additions & 3 deletions docs/buildah-from.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -299,9 +299,7 @@ process.

Set the OS/ARCH of the image to be pulled
to the provided value instead of using the current operating system and
architecture of the host (for example `linux/arm`). If `--platform`
is set, then the values of the `--arch`, `--os`, and `--variant` options will
be overridden.
architecture of the host (for example `linux/arm`).

OS/ARCH pairs are those used by the Go Programming Language. In several cases
the ARCH value for a platform differs from one produced by other tools such as
Expand All @@ -313,6 +311,8 @@ While `buildah from` is happy to pull an image for any platform that exists,
`buildah run` will not be able to run binaries provided by that image without
the help of emulation provided by packages like `qemu-user-static`.

**NOTE:** The `--platform` option may not be used in combination with the `--arch`, `--os`, or `--variant` options.

**--pull**

When the flag is enabled, attempt to pull the latest image from the registries
Expand Down
6 changes: 3 additions & 3 deletions docs/buildah-pull.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,16 +64,16 @@ Set the OS of the image to be pulled instead of using the current operating syst

Set the OS/ARCH of the image to be pulled
to the provided value instead of using the current operating system and
architecture of the host (for example `linux/arm`). If `--platform`
is set, then the values of the `--arch`, `--os`, and `--variant` options will
be overridden.
architecture of the host (for example `linux/arm`).

OS/ARCH pairs are those used by the Go Programming Language. In several cases
the ARCH value for a platform differs from one produced by other tools such as
the `arch` command. Valid OS and architecture name combinations are listed as
values for $GOOS and $GOARCH at https://golang.org/doc/install/source#environment,
and can also be found by running `go tool dist list`.

**NOTE:** The `--platform` option may not be used in combination with the `--arch`, `--os`, or `--variant` options.

**--policy**=**always**|**missing**|**never**

Pull image policy. The default is **missing**.
Expand Down

0 comments on commit 47c78dd

Please sign in to comment.