diff options
| author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2022-08-23 11:10:12 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-23 11:10:12 -0400 |
| commit | 8cfbcfe2a8827e726994e3d38ea38337e63ad538 (patch) | |
| tree | 236b4cdc90c7b5eb2dfbec34984f25a255be3c9b /docs/source/markdown | |
| parent | 8a32e516f7a29766b8aa54991d1b3987acd479bf (diff) | |
| parent | 5c9bac141ecdf7a87d40e0c0aba1d49893f24474 (diff) | |
| download | podman-8cfbcfe2a8827e726994e3d38ea38337e63ad538.tar.gz podman-8cfbcfe2a8827e726994e3d38ea38337e63ad538.tar.bz2 podman-8cfbcfe2a8827e726994e3d38ea38337e63ad538.zip | |
Merge pull request #15428 from edsantiago/docs_dedup_cpus
[CI:DOCS] Man pages: refactor common options: --cpus
Diffstat (limited to 'docs/source/markdown')
| -rw-r--r-- | docs/source/markdown/options/cpus.container.md | 11 | ||||
| -rw-r--r-- | docs/source/markdown/podman-create.1.md.in | 12 | ||||
| -rw-r--r-- | docs/source/markdown/podman-run.1.md.in | 12 |
3 files changed, 13 insertions, 22 deletions
diff --git a/docs/source/markdown/options/cpus.container.md b/docs/source/markdown/options/cpus.container.md new file mode 100644 index 000000000..63f243e11 --- /dev/null +++ b/docs/source/markdown/options/cpus.container.md @@ -0,0 +1,11 @@ +#### **--cpus**=*number* + +Number of CPUs. The default is *0.0* which means no limit. This is shorthand +for **--cpu-period** and **--cpu-quota**, so you may only set either +**--cpus** or **--cpu-period** and **--cpu-quota**. + +On some systems, changing the CPU limits may not be allowed for non-root +users. For more details, see +https://github.com/containers/podman/blob/main/troubleshooting.md#26-running-containers-with-resource-limits-fails-with-a-permissions-error + +This option is not supported on cgroups V1 rootless systems. diff --git a/docs/source/markdown/podman-create.1.md.in b/docs/source/markdown/podman-create.1.md.in index 2fecdb256..3ae558996 100644 --- a/docs/source/markdown/podman-create.1.md.in +++ b/docs/source/markdown/podman-create.1.md.in @@ -119,17 +119,7 @@ Block IO relative device weight. @@option cpu-shares -#### **--cpus**=*number* - -Number of CPUs. The default is *0.0* which means no limit. This is shorthand -for **--cpu-period** and **--cpu-quota**, so you may only set either -**--cpus** or **--cpu-period** and **--cpu-quota**. - -On some systems, changing the CPU limits may not be allowed for non-root -users. For more details, see -https://github.com/containers/podman/blob/main/troubleshooting.md#26-running-containers-with-resource-limits-fails-with-a-permissions-error - -This option is not supported on cgroups V1 rootless systems. +@@option cpus.container @@option cpuset-cpus diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in index 40e05c06c..4fae69241 100644 --- a/docs/source/markdown/podman-run.1.md.in +++ b/docs/source/markdown/podman-run.1.md.in @@ -134,17 +134,7 @@ each of **stdin**, **stdout**, and **stderr**. @@option cpu-shares -#### **--cpus**=*number* - -Number of CPUs. The default is *0.0* which means no limit. This is shorthand -for **--cpu-period** and **--cpu-quota**, so you may only set either -**--cpus** or **--cpu-period** and **--cpu-quota**. - -On some systems, changing the CPU limits may not be allowed for non-root -users. For more details, see -https://github.com/containers/podman/blob/main/troubleshooting.md#26-running-containers-with-resource-limits-fails-with-a-permissions-error - -This option is not supported on cgroups V1 rootless systems. +@@option cpus.container @@option cpuset-cpus |