diff options
| author | Faylixe <Faylixe@users.noreply.github.com> | 2016-07-08 10:41:39 +0200 |
|---|---|---|
| committer | Faylixe <felix.voituret@gmail.com> | 2016-07-08 10:44:49 +0200 |
| commit | 6d347cd8948d83545379703bbb501d45f203c63b (patch) | |
| tree | ecc00a80e385bb1b922e0acf586939f5350b4e04 | |
| parent | 94f8dd31be3a3f1802f6041a801f01a6e316ba49 (diff) | |
| download | docker-py-6d347cd8948d83545379703bbb501d45f203c63b.tar.gz | |
Update api.md
Added ``buildargs`` parameter to ``build`` documentation
Signed-off-by: Faylixe <felix.voituret@gmail.com>
| -rw-r--r-- | docs/api.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/api.md b/docs/api.md index 5b8ef22..07d7508 100644 --- a/docs/api.md +++ b/docs/api.md @@ -46,6 +46,8 @@ already, pass a readable file-like object to `fileobj` and also pass `custom_context=True`. If the stream is compressed also, set `encoding` to the correct value (e.g `gzip`). +Build argument can also be pass a a Python dict through ``buildargs`` parameter. + **Params**: * path (str): Path to the directory containing the Dockerfile @@ -65,6 +67,7 @@ correct value (e.g `gzip`). * pull (bool): Downloads any updates to the FROM image in Dockerfiles * forcerm (bool): Always remove intermediate containers, even after unsuccessful builds * dockerfile (str): path within the build context to the Dockerfile +* buildargs (dict): A dictionary of build arguments * container_limits (dict): A dictionary of limits applied to each container created by the build process. Valid keys: - memory (int): set memory limit for build |