From af14c6e7aa369ebca640ccb0197f9afbfd2e749a Mon Sep 17 00:00:00 2001 From: xlgao-zju Date: Sun, 6 Sep 2015 11:09:29 +0800 Subject: [PATCH] fix doc about vol Signed-off-by: xlgao-zju --- docs/reference/run.md | 13 +++++++++++++ docs/userguide/dockervolumes.md | 13 +++++++++++++ man/docker-run.1.md | 15 ++++++++++++++- 3 files changed, 40 insertions(+), 1 deletion(-) diff --git a/docs/reference/run.md b/docs/reference/run.md index bcb4ed32e2..7b19fcddba 100644 --- a/docs/reference/run.md +++ b/docs/reference/run.md @@ -1260,6 +1260,19 @@ 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 +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`. + +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. +If you supply the `/foo` value, Docker creates a bind-mount. If you supply +the `foo` specification, Docker creates a named volume. + ### USER `root` (id = 0) is the default user within a container. The image developer can diff --git a/docs/userguide/dockervolumes.md b/docs/userguide/dockervolumes.md index c08cf5c5c7..6328ebf4ca 100644 --- a/docs/userguide/dockervolumes.md +++ b/docs/userguide/dockervolumes.md @@ -105,6 +105,19 @@ image, the `/src/webapp` mount overlays but does not remove the pre-existing content. Once the mount is removed, the content is accessible again. This is consistent with the expected behavior of the `mount` command. +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 +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`. + +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. +If you supply the `/foo` value, Docker creates a bind-mount. If you supply +the `foo` specification, Docker creates a named volume. + If you are using Docker Machine on Mac or Windows, your Docker daemon has only limited access to your OS X or Windows filesystem. Docker Machine tries to auto-share your `/Users` (OS X) or `C:\Users` (Windows) directory. So, you can mount files or directories on OS X using. diff --git a/man/docker-run.1.md b/man/docker-run.1.md index 7fb9d0f162..a938fa06e8 100644 --- a/man/docker-run.1.md +++ b/man/docker-run.1.md @@ -435,7 +435,20 @@ content label. Shared volume labels allow all containers to read/write content. The `Z` option tells Docker to label the content with a private unshared label. Only the current container can use a private volume. -Note: Multiple Volume options can be added separated by a "," +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 +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`. + +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. +If you supply the `/foo` value, Docker creates a bind-mount. If you supply +the `foo` specification, Docker creates a named volume. + +**Note:** Multiple Volume options can be added separated by a , (comma). **--volumes-from**=[] Mount volumes from the specified container(s)