diff options
author | Greg Taylor <gtaylor@gc-taylor.com> | 2015-02-05 00:37:17 -0500 |
---|---|---|
committer | Greg Taylor <gtaylor@gc-taylor.com> | 2015-02-05 00:40:24 -0500 |
commit | 1379f431ff2dfcde9e8df96835272b8700808360 (patch) | |
tree | f378177301a62b88d83dc8e31f972b00ddb5e3dd | |
parent | 39ee2d55b2df24865095e032a50210aa42aa743a (diff) | |
download | docker-py-1379f431ff2dfcde9e8df96835272b8700808360.tar.gz |
Updating Client.build() doc to mention rm-mismatch. Fixes #332.
-rw-r--r-- | docs/api.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/api.md b/docs/api.md index 7d0f9df..dba4cde 100644 --- a/docs/api.md +++ b/docs/api.md @@ -52,7 +52,9 @@ correct value (e.g `gzip`). * quiet (bool): Whether to return the status * fileobj: A file object to use as the Dockerfile. (Or a file-like object) * nocache (bool): Don't use the cache when set to `True` -* rm (bool): Remove intermediate containers +* rm (bool): Remove intermediate containers. The `docker build` command now + defaults to ``--rm=true``, but we have kept the old default of `False` + to preserve backward compatibility * stream (bool): *Deprecated for API version > 1.8 (always True)*. Return a blocking generator you can iterate over to retrieve build output as it happens |