From 7bb4b56cf98662ef5f1deb64bdf8a120490bc258 Mon Sep 17 00:00:00 2001 From: Jessica Frazelle Date: Mon, 19 Jan 2015 16:16:36 -0800 Subject: [PATCH] Add docs for `--memory-swap`. Docker-DCO-1.1-Signed-off-by: Jessica Frazelle (github: jfrazelle) --- docs/man/docker-run.1.md | 6 ++++++ docs/sources/reference/commandline/cli.md | 1 + 2 files changed, 7 insertions(+) diff --git a/docs/man/docker-run.1.md b/docs/man/docker-run.1.md index b16447bc5a..a5e4fa2f2a 100644 --- a/docs/man/docker-run.1.md +++ b/docs/man/docker-run.1.md @@ -28,6 +28,7 @@ docker-run - Run a command in a new container [**--link**[=*[]*]] [**--lxc-conf**[=*[]*]] [**-m**|**--memory**[=*MEMORY*]] +[**--memory-swap**[=*MEMORY-SWAP]] [**--mac-address**[=*MAC-ADDRESS*]] [**--name**[=*NAME*]] [**--net**[=*"bridge"*]] @@ -191,6 +192,11 @@ actual limit may be rounded up to a multiple of the operating system's page size, if it is not already. The memory limit should be formatted as follows: ``, where unit = b, k, m or g. +**--memory-swap**="" + Total memory usage (memory + swap) + + Set '-1' to disable swap (format: , where unit = b, k, m or g) + **--mac-address**="" Container MAC address (e.g. 92:d0:c6:0a:29:33) diff --git a/docs/sources/reference/commandline/cli.md b/docs/sources/reference/commandline/cli.md index cb17a67eb2..d34c1f35ac 100644 --- a/docs/sources/reference/commandline/cli.md +++ b/docs/sources/reference/commandline/cli.md @@ -1605,6 +1605,7 @@ removed before the image is removed. --link=[] Add link to another container in the form of name:alias --lxc-conf=[] (lxc exec-driver only) Add custom lxc options --lxc-conf="lxc.cgroup.cpuset.cpus = 0,1" -m, --memory="" Memory limit (format: , where unit = b, k, m or g) + -memory-swap="" Total memory usage (memory + swap), set '-1' to disable swap (format: , where unit = b, k, m or g) --mac-address="" Container MAC address (e.g. 92:d0:c6:0a:29:33) --name="" Assign a name to the container --net="bridge" Set the Network mode for the container