aboutsummaryrefslogtreecommitdiffhomepage
path: root/tensorflow/tools/dockerfiles
diff options
context:
space:
mode:
authorGravatar Austin Anderson <angerson@google.com>2018-08-01 15:32:36 -0700
committerGravatar Austin Anderson <angerson@google.com>2018-08-01 15:32:36 -0700
commit00869fc36a952418ffa75fd4fd5763b993251dd2 (patch)
treef215e8504f7c3b0004ab38a0343aa025a209fec9 /tensorflow/tools/dockerfiles
parent04fb295a409b426ea44463934c4cec251990bc37 (diff)
Clean up some documentation
Diffstat (limited to 'tensorflow/tools/dockerfiles')
-rw-r--r--tensorflow/tools/dockerfiles/assembler.py3
-rw-r--r--tensorflow/tools/dockerfiles/spec.yml43
2 files changed, 25 insertions, 21 deletions
diff --git a/tensorflow/tools/dockerfiles/assembler.py b/tensorflow/tools/dockerfiles/assembler.py
index a33c42ace6..8e0e5923d6 100644
--- a/tensorflow/tools/dockerfiles/assembler.py
+++ b/tensorflow/tools/dockerfiles/assembler.py
@@ -1,6 +1,7 @@
"""Assemble common TF Dockerfiles from many parts.
-TODO(angerson): DO NOT SUBMIT without a detailed description of assembler.
+This script constructs TF's Dockerfiles by aggregating partial
+Dockerfiles. See README.md for usage examples.
"""
from __future__ import absolute_import
diff --git a/tensorflow/tools/dockerfiles/spec.yml b/tensorflow/tools/dockerfiles/spec.yml
index 48a0cb772e..4d622c53d2 100644
--- a/tensorflow/tools/dockerfiles/spec.yml
+++ b/tensorflow/tools/dockerfiles/spec.yml
@@ -1,6 +1,7 @@
# ======
# HEADER
# ======
+#
# This is commented-out and prepended to each generated Dockerfile.
header: |
THIS IS A GENERATED DOCKERFILE.
@@ -12,19 +13,20 @@ header: |
# ========
# PARTIALS
# ========
-# Represent and document pieces of a Dockerfile.
-# Spec:
+#
+# Represent and document pieces of a Dockerfile. Spec:
#
-# name: the name of the partial, referenced from other sections
+# name: the name of the partial, is referenced from the images section
# desc: A description, inserted later into the Dockerfile
-# file: Alternative file prefix, e.g. file.partial.Dockerfile (default = name)
+# file: Alternative file prefix, e.g. file.partial.Dockerfile. The default is
+# the name of the partial.
# args: A dict of ARGs in the Dockerfile; each entry has the format
-# ARG_NAME: VALUE where VALUE is
-# - a concrete value: becomes the default
+# ARG_NAME: VALUE where VALUE is one of:
# - a dict:
-# desc: Arg description
-# default: Default value for the arg; is written to the Dockerfile
-# options: List of strings, part of documentation
+# desc: Documentation for the arg
+# default: Default value for the arg; is written to the Dockerfile
+# options: List of strings, part of documentation
+# - a concrete value: the same as a dictionary with default: [value].
partials:
ubuntu:
@@ -75,23 +77,24 @@ partials:
jupyter:
desc: Launch Jupyter on execution instead of a bash prompt.
-# ===========
-# DOCKERFILES
-# ===========
-# Represent dockerfiles.
-# Spec:
+# ======
+# IMAGES
+# ======
+#
+# Represent Dockerfiles. Spec:
#
-# name: the name of the image, referenced from other sections
+# name: the name of the image, possibly referenced by other images
# desc: A description, inserted later into the Dockerfile
# create-dockerfile: Create a dockerfile based on this. Useful for creating
-# base images. Default is true
+# extensible base images that don't need a file. Default is true.
# partials: List of VALUEs, where a VALUE is either:
-# - the name of a partial, which inserts that partial into this file
+# - the name of a partial, which inserts that partial into this image
# - image: [name of another image], which inserts the partials from that
-# image into this file
+# image into this image
# arg-defaults: List of VALUEs, where a VALUE is either:
-# - the name of another image, which loads the default args from that image
-# - ARG_NAME: VALUE, which is exactly what you'd expect
+# - ARG_NAME: VALUE, which sets the ARG_NAME to VALUE wherever it appears
+# in this image's partials
+# - [name of another image], which loads the default args from that image
images:
nodev: