Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CI:DOCS] elaborate on image lookups of foreign platforms #15409

Merged
merged 1 commit into from
Aug 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/markdown/options/arch.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
#### **--arch**=*ARCH*
Override the architecture, defaults to hosts, of the image to be pulled. For example, `arm`.
Unless overridden, subsequent lookups of the same image in the local storage will match this architecture, regardless of the host.
1 change: 1 addition & 0 deletions docs/source/markdown/options/platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@

Specify the platform for selecting the image. (Conflicts with --arch and --os)
The `--platform` option can be used to override the current architecture and operating system.
Unless overridden, subsequent lookups of the same image in the local storage will match this platform, regardless of the host.
17 changes: 11 additions & 6 deletions docs/source/markdown/podman-build.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,9 @@ discarded when writing images in Docker formats.

Set the architecture of the image to be built, and that of the base image to be
pulled, if the build uses one, to the provided value instead of using the
architecture of the build host. (Examples: arm, arm64, 386, amd64, ppc64le,
s390x)
architecture of the build host. Unless overridden, subsequent lookups of the
same image in the local storage will match this architecture, regardless of the
host. (Examples: arm, arm64, 386, amd64, ppc64le, s390x)

@@option authfile

Expand Down Expand Up @@ -454,7 +455,8 @@ do not include `History` information in their images.

Set the OS of the image to be built, and that of the base image to be pulled,
if the build uses one, instead of using the current operating system of the
build host.
build host. Unless overridden, subsequent lookups of the same image in the
local storage will match this OS, regardless of the host.

#### **--os-feature**=*feature*

Expand Down Expand Up @@ -506,9 +508,12 @@ 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`). Unless overridden,
subsequent lookups of the same image in the local storage will match this
platform, regardless of the host.

If `--platform` is set, then the values of the `--arch`, `--os`, and
`--variant` options will be overridden.

The `--platform` option can be specified more than once, or given a
comma-separated list of values as its argument. When more than one platform is
Expand Down
1 change: 1 addition & 0 deletions docs/source/markdown/podman-create.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -452,6 +452,7 @@ This option conflicts with **--add-host**.

#### **--os**=*OS*
Override the OS, defaults to hosts, of the image to be pulled. For example, `windows`.
Unless overridden, subsequent lookups of the same image in the local storage will match this OS, regardless of the host.

@@option passwd-entry

Expand Down
1 change: 1 addition & 0 deletions docs/source/markdown/podman-pull.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ Print the usage statement.
#### **--os**=*OS*

Override the OS, defaults to hosts, of the image to be pulled. For example, `windows`.
Unless overridden, subsequent lookups of the same image in the local storage will match this OS, regardless of the host.

@@option platform

Expand Down
1 change: 1 addition & 0 deletions docs/source/markdown/podman-run.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -465,6 +465,7 @@ This option conflicts with **--add-host**.

#### **--os**=*OS*
Override the OS, defaults to hosts, of the image to be pulled. For example, `windows`.
Unless overridden, subsequent lookups of the same image in the local storage will match this OS, regardless of the host.

#### **--passwd**

Expand Down