From 4fbaeb5f25fa133841542fdd4b17b66ce9e067e1 Mon Sep 17 00:00:00 2001 From: "Kai Qiang Wu(Kennan)" Date: Wed, 11 Nov 2015 20:23:49 -0600 Subject: [PATCH] Fixing the volume options doc Fixes #15896 Signed-off-by: Kai Qiang Wu(Kennan) --- docs/reference/commandline/create.md | 7 ++++++- docs/reference/commandline/run.md | 7 ++++++- docs/reference/run.md | 10 +++++----- 3 files changed, 17 insertions(+), 7 deletions(-) diff --git a/docs/reference/commandline/create.md b/docs/reference/commandline/create.md index a7ed5dda17..d096179642 100644 --- a/docs/reference/commandline/create.md +++ b/docs/reference/commandline/create.md @@ -70,7 +70,12 @@ Creates a new container. -u, --user="" Username or UID --ulimit=[] Ulimit options --uts="" UTS namespace to use - -v, --volume=[] Bind mount a volume + -v, --volume=[] Bind mount a volume with: [host-src:]container-dest[:], where + options are comma delimited and selected from [rw|ro] and [z|Z]. + The 'host-src' can either be an absolute path or a name value. + If 'host-src' is missing, then docker creates a new volume. + If neither 'rw' or 'ro' is specified then the volume is mounted + in read-write mode. --volumes-from=[] Mount volumes from the specified container(s) -w, --workdir="" Working directory inside the container diff --git a/docs/reference/commandline/run.md b/docs/reference/commandline/run.md index 5d6ad1877f..a7dbc2f112 100644 --- a/docs/reference/commandline/run.md +++ b/docs/reference/commandline/run.md @@ -76,7 +76,12 @@ parent = "smn_cli" -u, --user="" Username or UID (format: [:]) --ulimit=[] Ulimit options --uts="" UTS namespace to use - -v, --volume=[] Bind mount a volume + -v, --volume=[] Bind mount a volume with: [host-src:]container-dest[:], where + options are comma delimited and selected from [rw|ro] and [z|Z]. + The 'host-src' can either be an absolute path or a name value. + If 'host-src' is missing, then docker creates a new volume. + If neither 'rw' or 'ro' is specified then the volume is mounted + in read-write mode. --volumes-from=[] Mount volumes from the specified container(s) -w, --workdir="" Working directory inside the container diff --git a/docs/reference/run.md b/docs/reference/run.md index a14429651e..e9b3a85aaa 100644 --- a/docs/reference/run.md +++ b/docs/reference/run.md @@ -1300,9 +1300,9 @@ Similarly the operator can set the **hostname** with `-h`. ### VOLUME (shared filesystems) - -v=[]: Create a bind mount with: [host-dir:]container-dir[:], where + -v=[]: Create a bind mount with: [host-src:]container-dest[:], where options are comma delimited and selected from [rw|ro] and [z|Z]. - If 'host-dir' is missing, then docker creates a new volume. + If 'host-src' is missing, then docker creates a new volume. If neither 'rw' or 'ro' is specified then the volume is mounted in read-write mode. --volumes-from="": Mount all volumes from the given container(s) @@ -1317,8 +1317,8 @@ one or more `VOLUME`'s associated with an image, but only the operator can give access from one container to another (or from a container to a volume mounted on the host). -The `container-dir` must always be an absolute path such as `/src/docs`. -The `host-dir` can either be an absolute path or a `name` value. If you +The `container-dest` must always be an absolute path such as `/src/docs`. +The `host-src` can either be an absolute path or a `name` value. If you supply an absolute path for the `host-dir`, Docker bind-mounts to the path you specify. If you supply a `name`, Docker creates a named volume by that `name`. @@ -1326,7 +1326,7 @@ A `name` value must start with start with an alphanumeric character, followed by `a-z0-9`, `_` (underscore), `.` (period) or `-` (hyphen). An absolute path starts with a `/` (forward slash). -For example, you can specify either `/foo` or `foo` for a `host-dir` value. +For example, you can specify either `/foo` or `foo` for a `host-src` value. If you supply the `/foo` value, Docker creates a bind-mount. If you supply the `foo` specification, Docker creates a named volume.