From 6fd1c7b5eed70911c693c60c8a4fe9060114fc01 Mon Sep 17 00:00:00 2001 From: Matt Heon Date: Fri, 30 May 2014 13:55:13 -0400 Subject: [PATCH] Documented special case of container memory limits in manpages If a container is started with a memory limit of 0, no memory limit is applied. To prevent this from causing confusion, make interaction explicit in docs. Docker-DCO-1.1-Signed-off-by: Matthew Heon (github: mheon) Upstream-commit: ba1c0f4c817e958693cfcef30f1de9991765d5db Component: engine --- components/engine/contrib/man/md/docker-run.1.md | 4 ++-- components/engine/contrib/man/old-man/docker-run.1 | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/components/engine/contrib/man/md/docker-run.1.md b/components/engine/contrib/man/md/docker-run.1.md index e90ecab85f..3d2420cdbd 100644 --- a/components/engine/contrib/man/md/docker-run.1.md +++ b/components/engine/contrib/man/md/docker-run.1.md @@ -100,8 +100,8 @@ container can be started with the **--link**. **-m**, **-memory**=*memory-limit* 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. The memory limit format: , where unit = b, k, m or -g. +RAM. If a limit of 0 is specified, the container's memory is not limited. The +memory limit format: , where unit = b, k, m or g. **-P**, **-publish-all**=*true*|*false* When set to true publish all exposed ports to the host interfaces. The diff --git a/components/engine/contrib/man/old-man/docker-run.1 b/components/engine/contrib/man/old-man/docker-run.1 index ae0295943d..0e06e8d682 100644 --- a/components/engine/contrib/man/old-man/docker-run.1 +++ b/components/engine/contrib/man/old-man/docker-run.1 @@ -39,7 +39,7 @@ CPU shares in relative weight. You can increase the priority of a container with .TP .B -m, --memory=\fImemory-limit\fR: -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. The memory limit format: , where unit = b, k, m or g. +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, the container's memory is not limited. The memory limit format: , where unit = b, k, m or g. .TP .B --cidfile=\fIfile\fR: