docker
/
docker-py
mirror of https://github.com/docker/docker-py.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update api.md 

Added ``buildargs`` parameter to ``build`` documentation

Signed-off-by: Faylixe <felix.voituret@gmail.com>
This commit is contained in:
Faylixe 2016-07-08 10:41:39 +02:00 committed by Faylixe
parent 94f8dd31be
commit 6d347cd894
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/api.md
View File

@ -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 `custom_context=True`. If the stream is compressed also, set `encoding` to the
correct value (e.g `gzip`). correct value (e.g `gzip`).
Build argument can also be pass a a Python dict through ``buildargs`` parameter.
**Params**: **Params**:
* path (str): Path to the directory containing the Dockerfile * 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 * pull (bool): Downloads any updates to the FROM image in Dockerfiles
* forcerm (bool): Always remove intermediate containers, even after unsuccessful builds * forcerm (bool): Always remove intermediate containers, even after unsuccessful builds
* dockerfile (str): path within the build context to the Dockerfile * 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 * container_limits (dict): A dictionary of limits applied to each container
created by the build process. Valid keys: created by the build process. Valid keys:
- memory (int): set memory limit for build - memory (int): set memory limit for build