From 4361366783bbb4c9e4bd87e1c16da5a0988ed0bd Mon Sep 17 00:00:00 2001 From: Matthew Heon Date: Wed, 25 Jun 2014 11:25:54 -0400 Subject: [PATCH] Document memory limit sizing in manpages The -m flag permits the setting of a memory limit when running a Docker container. The actual limit set must be a multiple of page size on Linux, so whatever number the uses passes in will be rounded up if needed. Document this behavior to prevent confusion. Also fixed several small formatting and grammar issues in the docker run manpage. Docker-DCO-1.1-Signed-off-by: Matthew Heon (github: mheon) --- docs/man/docker-run.1.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/man/docker-run.1.md b/docs/man/docker-run.1.md index 447d9e13c3..2ef7f50489 100644 --- a/docs/man/docker-run.1.md +++ b/docs/man/docker-run.1.md @@ -103,8 +103,10 @@ 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. 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. +RAM. If a limit of 0 is specified, the container's memory is not limited. The +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. **-P**, **-publish-all**=*true*|*false* When set to true publish all exposed ports to the host interfaces. The