From 97daf9864d835ae0883b3c03382ac5dca11b4cc9 Mon Sep 17 00:00:00 2001
From: "O.S.Tezer" <ostezer@gmail.com>
Date: Sat, 19 Apr 2014 04:26:14 +0300
Subject: [PATCH] Urgent fix for crazy docs error on volumes.
Elaborate on the volumes example to prevent confusion.
Update: Amend the example so it is executable by the reader.
This includes fixing the erring "/var/logs" statement with "/var/log".
Update: Fix sentence structuring to better suit the 80chrs. limit.
Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
---
docs/sources/use/working_with_volumes.md | 26 ++++++++++++------------
1 file changed, 13 insertions(+), 13 deletions(-)
diff --git a/docs/sources/use/working_with_volumes.md b/docs/sources/use/working_with_volumes.md
index 1f03101b86..df48671dde 100644
--- a/docs/sources/use/working_with_volumes.md
+++ b/docs/sources/use/working_with_volumes.md
@@ -94,24 +94,24 @@ upgrade, or effectively migrate data volumes between containers.
-v=[]: Create a bind mount with: [host-dir]:[container-dir]:[rw|ro].
-You must specify an absolute path for `host-dir`. If
-`host-dir` is missing from the command, then docker
-creates a new volume. If `host-dir` is present but
-points to a non-existent directory on the host, Docker will
-automatically create this directory and use it as the source of the
-bind-mount.
+You must specify an absolute path for `host-dir`. If `host-dir` is missing from
+the command, then Docker creates a new volume. If `host-dir` is present but
+points to a non-existent directory on the host, Docker will automatically
+create this directory and use it as the source of the bind-mount.
-Note that this is not available from a Dockerfile due the portability
-and sharing purpose of it. The `host-dir` volumes
-are entirely host-dependent and might not work on any other machine.
+Note that this is not available from a Dockerfile due the portability and
+sharing purpose of it. The `host-dir` volumes are entirely host-dependent
+and might not work on any other machine.
For example:
- sudo docker run -t -i -v /var/logs:/var/host_logs:ro ubuntu bash
+ # Usage:
+ # sudo docker run [OPTIONS] -v /(dir. on host):/(dir. in container):(Read-Write or Read-Only) [ARG..]
+ # Example:
+ sudo docker run -i -t -v /var/log:/logs_from_host:ro ubuntu bash
-The command above mounts the host directory `/var/logs`
-into the container with read only permissions as
-`/var/host_logs`.
+The command above mounts the host directory `/var/log` into the container
+with *read only* permissions as `/logs_from_host`.
New in version v0.5.0.