mirror of
https://github.com/containers/podman.git
synced 2025-06-19 16:33:24 +08:00
Merge pull request #15636 from edsantiago/docs_dedup_memory
[CI:DOCS] Man pages: refactor common options: --memory*
This commit is contained in:
@ -391,28 +391,9 @@ This option is not supported on the remote client, including Mac and Windows
|
||||
Name of the manifest list to which the image will be added. Creates the manifest list
|
||||
if it does not exist. This option is useful for building multi architecture images.
|
||||
|
||||
#### **--memory**, **-m**=*LIMIT*
|
||||
@@option memory
|
||||
|
||||
Memory limit (format: `<number>[<unit>]`, where unit = b (bytes), k (kibibytes),
|
||||
m (mebibytes), or g (gibibytes))
|
||||
|
||||
Allows you to constrain the memory available to a container. If the host
|
||||
supports swap memory, then the **-m** memory setting can be larger than physical
|
||||
RAM. If a limit of 0 is specified (not using **-m**), the container's memory is
|
||||
not limited. The actual limit may be rounded up to a multiple of the operating
|
||||
system's page size (the value would be very large, that's millions of
|
||||
trillions).
|
||||
|
||||
#### **--memory-swap**=*LIMIT*
|
||||
|
||||
A limit value equal to memory plus swap. Must be used with the **-m**
|
||||
(**--memory**) option. The swap `LIMIT` should always be larger than **-m**
|
||||
(**--memory**) value. By default, the swap `LIMIT` will be set to double
|
||||
the value of --memory.
|
||||
|
||||
The format of `LIMIT` is `<number>[<unit>]`. Unit can be `b` (bytes),
|
||||
`k` (kibibytes), `m` (mebibytes), or `g` (gibibytes). If you don't specify a
|
||||
unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap.
|
||||
@@option memory-swap
|
||||
|
||||
#### **--network**=*mode*, **--net**
|
||||
|
||||
|
@ -64,28 +64,15 @@ Force removal of the original container that we are cloning. Can only be used in
|
||||
|
||||
If no memory limits are specified, the original container's will be used.
|
||||
|
||||
#### **--memory-reservation**=*limit*
|
||||
@@option memory-reservation
|
||||
|
||||
Memory soft limit (format: `<number>[<unit>]`, where unit = b (bytes), k (kibibytes), m (mebibytes), or g (gibibytes))
|
||||
If unspecified, memory reservation will be the same as memory limit from the
|
||||
container being cloned.
|
||||
|
||||
After setting memory reservation, when the system detects memory contention
|
||||
or low memory, containers are forced to restrict their consumption to their
|
||||
reservation. So you should always set the value below **--memory**, otherwise the
|
||||
hard limit will take precedence. By default, memory reservation will be the same
|
||||
as memory limit from the container being cloned.
|
||||
@@option memory-swap
|
||||
|
||||
#### **--memory-swap**=*limit*
|
||||
|
||||
A limit value equal to memory plus swap. Must be used with the **-m**
|
||||
(**--memory**) flag. The swap `LIMIT` should always be larger than **-m**
|
||||
(**--memory**) value. By default, the swap `LIMIT` will be set to double
|
||||
the value of --memory if specified. Otherwise, the container being cloned will be used to derive the swap value.
|
||||
|
||||
The format of `LIMIT` is `<number>[<unit>]`. Unit can be `b` (bytes),
|
||||
`k` (kibibytes), `m` (mebibytes), or `g` (gibibytes). If you don't specify a
|
||||
unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap.
|
||||
|
||||
This option is not supported on cgroups V1 rootless systems.
|
||||
If unspecified, the container being cloned will be used to derive
|
||||
the swap value.
|
||||
|
||||
@@option memory-swappiness
|
||||
|
||||
|
@ -70,26 +70,9 @@ Print usage statement.
|
||||
|
||||
@@option label-file
|
||||
|
||||
#### **--memory**, **-m**=*limit*
|
||||
@@option memory
|
||||
|
||||
Memory limit (format: `<number>[<unit>]`, where unit = b (bytes), k (kibibytes), m (mebibytes), or g (gibibytes))
|
||||
|
||||
Constrains the memory available to a container. If the host
|
||||
supports swap memory, then the **-m** memory setting can be larger than physical
|
||||
RAM. If a limit of 0 is specified (not using **-m**), the container's memory is
|
||||
not limited. The actual limit may be rounded up to a multiple of the operating
|
||||
system's page size (the value would be very large, that's millions of trillions).
|
||||
|
||||
#### **--memory-swap**=*limit*
|
||||
|
||||
A limit value equal to memory plus swap. Must be used with the **-m**
|
||||
(**--memory**) flag. The swap `LIMIT` should always be larger than **-m**
|
||||
(**--memory**) value. By default, the swap `LIMIT` will be set to double
|
||||
the value of --memory.
|
||||
|
||||
The format of `LIMIT` is `<number>[<unit>]`. Unit can be `b` (bytes),
|
||||
`k` (kibibytes), `m` (mebibytes), or `g` (gibibytes). If you don't specify a
|
||||
unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap.
|
||||
@@option memory-swap
|
||||
|
||||
#### **--name**, **-n**
|
||||
|
||||
|
@ -136,26 +136,9 @@ To specify multiple static IPv6 addresses per pod, set multiple networks using t
|
||||
|
||||
@@option mac-address
|
||||
|
||||
#### **--memory**, **-m**=*limit*
|
||||
@@option memory
|
||||
|
||||
Memory limit (format: `<number>[<unit>]`, where unit = b (bytes), k (kibibytes), m (mebibytes), or g (gibibytes))
|
||||
|
||||
Constrains the memory available to a container. If the host
|
||||
supports swap memory, then the **-m** memory setting can be larger than physical
|
||||
RAM. If a limit of 0 is specified (not using **-m**), the container's memory is
|
||||
not limited. The actual limit may be rounded up to a multiple of the operating
|
||||
system's page size (the value would be very large, that's millions of trillions).
|
||||
|
||||
#### **--memory-swap**=*limit*
|
||||
|
||||
A limit value equal to memory plus swap. Must be used with the **-m**
|
||||
(**--memory**) flag. The swap `LIMIT` should always be larger than **-m**
|
||||
(**--memory**) value. By default, the swap `LIMIT` will be set to double
|
||||
the value of --memory.
|
||||
|
||||
The format of `LIMIT` is `<number>[<unit>]`. Unit can be `b` (bytes),
|
||||
`k` (kibibytes), `m` (mebibytes), or `g` (gibibytes). If you don't specify a
|
||||
unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap.
|
||||
@@option memory-swap
|
||||
|
||||
#### **--name**, **-n**=*name*
|
||||
|
||||
|
@ -307,15 +307,7 @@ This option is currently supported only by the **journald** log driver.
|
||||
|
||||
@@option mac-address
|
||||
|
||||
#### **--memory**, **-m**=*number[unit]*
|
||||
|
||||
Memory limit. A _unit_ can be **b** (bytes), **k** (kibibytes), **m** (mebibytes), or **g** (gibibytes).
|
||||
|
||||
Allows you to constrain the memory available to a container. If the host
|
||||
supports swap memory, then the **-m** memory setting can be larger than physical
|
||||
RAM. If a limit of 0 is specified (not using **-m**), the container's memory is
|
||||
not limited. The actual limit may be rounded up to a multiple of the operating
|
||||
system's page size (the value would be very large, that's millions of trillions).
|
||||
@@option memory
|
||||
|
||||
@@option memory-reservation
|
||||
|
||||
|
Reference in New Issue
Block a user