summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNicolas Delaby <nicolas.delaby@ezeep.com>2014-04-24 09:15:48 +0200
committerNicolas Delaby <nicolas.delaby@ezeep.com>2014-04-24 09:15:48 +0200
commitce782e190f4b3abab951cfd61e54ccb2c20d0c40 (patch)
treeb21645de38dba598722b8442c74d18e9aaac0512 /README.md
parent985893782914e89e059e1942315d9a7a9c7fa2c6 (diff)
downloaddocker-py-ce782e190f4b3abab951cfd61e54ccb2c20d0c40.tar.gz
Update documentation to reflect modification for `dns` and `volumes_from`
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index 6fceda9..d004a47 100644
--- a/README.md
+++ b/README.md
@@ -71,6 +71,11 @@ to those for the `docker run` command except it doesn't support the
attach options (`-a`). See "Port bindings" and "Using volumes" below for
more information on how to create port bindings and volume mappings.
+`volumes_from` and `dns` arguments raise TypeError exception if they are used
+against v1.10 of docker remote API. Those arguments should be passed to
+`start()` instead.
+
+
```python
c.diff(container)
```
@@ -201,7 +206,8 @@ Identical to the `docker search` command.
```python
c.start(container, binds=None, port_bindings=None, lxc_conf=None,
- publish_all_ports=False, links=None, privileged=False)
+ publish_all_ports=False, links=None, privileged=False,
+ dns=None, volumes_from=None)
```
Similar to the `docker start` command, but doesn't support attach
@@ -218,6 +224,9 @@ can be specified with the `links` argument. They can either be
specified as a dictionary mapping name to alias or as a list of
`(name, alias)` tuples.
+`dns` and `volumes_from` are only available if they are used with version v1.10
+of docker remote API. Otherwise they are ignored.
+
```python
c.stop(container, timeout=10)
```