From b87dd1342f3aa1be24ee81400a4468c38bf6b63e Mon Sep 17 00:00:00 2001 From: Qiang Huang Date: Wed, 30 Dec 2015 09:23:35 +0800 Subject: [PATCH] Fix docs for memory-swap Fixes: #18894 Signed-off-by: Qiang Huang --- docs/reference/commandline/build.md | 2 +- docs/reference/commandline/create.md | 2 +- docs/reference/commandline/run.md | 2 +- man/docker-build.1.md | 12 +++++++++--- man/docker-create.1.md | 13 ++++++++----- man/docker-run.1.md | 13 ++++++++----- 6 files changed, 28 insertions(+), 16 deletions(-) diff --git a/docs/reference/commandline/build.md b/docs/reference/commandline/build.md index eab0cb7e..adc94f53 100644 --- a/docs/reference/commandline/build.md +++ b/docs/reference/commandline/build.md @@ -27,7 +27,7 @@ parent = "smn_cli" --help Print usage --isolation="" Container isolation technology -m, --memory="" Memory limit for all build containers - --memory-swap="" Total memory (memory + swap), `-1` to disable swap + --memory-swap="" A positive integer equal to memory plus swap. Specify -1 to enable unlimited swap. --no-cache Do not use cache when building the image --pull Always attempt to pull a newer version of the image -q, --quiet Suppress the build output and print image ID on success diff --git a/docs/reference/commandline/create.md b/docs/reference/commandline/create.md index d6a9cc53..0a5e2479 100644 --- a/docs/reference/commandline/create.md +++ b/docs/reference/commandline/create.md @@ -57,7 +57,7 @@ Creates a new container. -m, --memory="" Memory limit --mac-address="" Container MAC address (e.g. 92:d0:c6:0a:29:33) --memory-reservation="" Memory soft limit - --memory-swap="" Total memory (memory + swap), '-1' to disable swap + --memory-swap="" A positive integer equal to memory plus swap. Specify -1 to enable unlimited swap. --memory-swappiness="" Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. --name="" Assign a name to the container --net="bridge" Connect a container to a network diff --git a/docs/reference/commandline/run.md b/docs/reference/commandline/run.md index 89243c6b..c42ca23e 100644 --- a/docs/reference/commandline/run.md +++ b/docs/reference/commandline/run.md @@ -56,7 +56,7 @@ parent = "smn_cli" -m, --memory="" Memory limit --mac-address="" Container MAC address (e.g. 92:d0:c6:0a:29:33) --memory-reservation="" Memory soft limit - --memory-swap="" Total memory (memory + swap), '-1' to disable swap + --memory-swap="" A positive integer equal to memory plus swap. Specify -1 to enable unlimited swap. --memory-swappiness="" Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. --name="" Assign a name to the container --net="bridge" Connect a container to a network diff --git a/man/docker-build.1.md b/man/docker-build.1.md index 3decabe1..91f15fe0 100644 --- a/man/docker-build.1.md +++ b/man/docker-build.1.md @@ -19,7 +19,7 @@ docker-build - Build a new image from the source code at PATH [**--rm**[=*true*]] [**-t**|**--tag**[=*[]*]] [**-m**|**--memory**[=*MEMORY*]] -[**--memory-swap**[=*MEMORY-SWAP*]] +[**--memory-swap**[=*LIMIT*]] [**--shm-size**[=*SHM-SIZE*]] [**--cpu-period**[=*0*]] [**--cpu-quota**[=*0*]] @@ -92,8 +92,14 @@ set as the **URL**, the repository is cloned locally and then sent as the contex **-m**, **--memory**=*MEMORY* Memory limit -**--memory-swap**=*MEMORY-SWAP* - Total memory (memory + swap), '-1' to disable 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. + + The format of `LIMIT` is `[]`. Unit can be `b` (bytes), +`k` (kilobytes), `m` (megabytes), or `g` (gigabytes). If you don't specify a +unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap. **--shm-size**=*SHM-SIZE* Size of `/dev/shm`. The format is ``. `number` must be greater than `0`. diff --git a/man/docker-create.1.md b/man/docker-create.1.md index f35571a3..f0499e60 100644 --- a/man/docker-create.1.md +++ b/man/docker-create.1.md @@ -46,7 +46,7 @@ docker-create - Create a new container [**-m**|**--memory**[=*MEMORY*]] [**--mac-address**[=*MAC-ADDRESS*]] [**--memory-reservation**[=*MEMORY-RESERVATION*]] -[**--memory-swap**[=*MEMORY-SWAP*]] +[**--memory-swap**[=*LIMIT*]] [**--memory-swappiness**[=*MEMORY-SWAPPINESS*]] [**--name**[=*NAME*]] [**--net**[=*"bridge"*]] @@ -230,11 +230,14 @@ reservation. So you should always set the value below **--memory**, otherwise th hard limit will take precedence. By default, memory reservation will be the same as memory limit. -**--memory-swap**="" - Total memory limit (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. - Set `-1` to disable swap (format: [], where unit = b, k, m or g). -This value should always larger than **-m**, so you should always use this with **-m**. + The format of `LIMIT` is `[]`. Unit can be `b` (bytes), +`k` (kilobytes), `m` (megabytes), or `g` (gigabytes). If you don't specify a +unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap. **--memory-swappiness**="" Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100. diff --git a/man/docker-run.1.md b/man/docker-run.1.md index e963d527..6d787295 100644 --- a/man/docker-run.1.md +++ b/man/docker-run.1.md @@ -47,7 +47,7 @@ docker-run - Run a command in a new container [**-m**|**--memory**[=*MEMORY*]] [**--mac-address**[=*MAC-ADDRESS*]] [**--memory-reservation**[=*MEMORY-RESERVATION*]] -[**--memory-swap**[=*MEMORY-SWAP*]] +[**--memory-swap**[=*LIMIT*]] [**--memory-swappiness**[=*MEMORY-SWAPPINESS*]] [**--name**[=*NAME*]] [**--net**[=*"bridge"*]] @@ -327,11 +327,14 @@ reservation. So you should always set the value below **--memory**, otherwise th hard limit will take precedence. By default, memory reservation will be the same as memory limit. -**--memory-swap**="" - Total memory limit (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. - Set `-1` to disable swap (format: [], where unit = b, k, m or g). -This value should always larger than **-m**, so you should always use this with **-m**. + The format of `LIMIT` is `[]`. Unit can be `b` (bytes), +`k` (kilobytes), `m` (megabytes), or `g` (gigabytes). If you don't specify a +unit, `b` is used. Set LIMIT to `-1` to enable unlimited swap. **--mac-address**="" Container MAC address (e.g. 92:d0:c6:0a:29:33)