Browse Source

Merge pull request #10206 from jfrazelle/add-docs-memory-swap

Add docs for `--memory-swap`.
James Turnbull 10 years ago
parent
commit
a276706719
2 changed files with 7 additions and 0 deletions
  1. 6 0
      docs/man/docker-run.1.md
  2. 1 0
      docs/sources/reference/commandline/cli.md

+ 6 - 0
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:
 `<number><optional unit>`, where unit = b, k, m or g.
 
+**--memory-swap**=""
+    Total memory usage (memory + swap)
+
+    Set '-1' to disable swap (format: <number><optional unit>, where unit = b, k, m or g)
+
 **--mac-address**=""
    Container MAC address (e.g. 92:d0:c6:0a:29:33)
 

+ 1 - 0
docs/sources/reference/commandline/cli.md

@@ -1613,6 +1613,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: <number><optional unit>, where unit = b, k, m or g)
+      -memory-swap=""            Total memory usage (memory + swap), set '-1' to disable swap (format: <number><optional unit>, 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