From 6d347cd8948d83545379703bbb501d45f203c63b Mon Sep 17 00:00:00 2001 From: Faylixe Date: Fri, 8 Jul 2016 10:41:39 +0200 Subject: [PATCH] Update api.md Added ``buildargs`` parameter to ``build`` documentation Signed-off-by: Faylixe --- docs/api.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/api.md b/docs/api.md index 5b8ef22b..07d75088 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