Update reference docs for the new flag.

Signed-off-by: Daniel Nephin <[email protected]>
docker · Mar 2, 2016 · e1b87d7 · e1b87d7
1 parent b7fb3a6
commit e1b87d7
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 27 deletions.
diff --git a/compose/service.py b/compose/service.py
@@ -294,9 +294,9 @@ def ensure_image_exists(self, do_build=BuildAction.none):
 
         self.build()
         log.warn(
-            "Image for service {} was build because it was not found. To "
-            "rebuild this image you must use the `build` command or the "
-            "--build flag.".format(self.name))
+            "Image for service {} was built because it did not already exist. To "
+            "rebuild this image you must use `docker-compose build` or "
+            "`docker-compose up --build`.".format(self.name))
 
     def image(self):
         try:

diff --git a/docs/reference/create.md b/docs/reference/create.md
@@ -12,14 +12,15 @@ parent = "smn_compose_cli"
 # create
 
 ```
+Creates containers for a service.
+
 Usage: create [options] [SERVICE...]
 
 Options:
---force-recreate       Recreate containers even if their configuration and
-                       image haven't changed. Incompatible with --no-recreate.
---no-recreate          If containers already exist, don't recreate them.
-                       Incompatible with --force-recreate.
---no-build             Don't build an image, even if it's missing
+    --force-recreate       Recreate containers even if their configuration and
+                           image haven't changed. Incompatible with --no-recreate.
+    --no-recreate          If containers already exist, don't recreate them.
+                           Incompatible with --force-recreate.
+    --no-build             Don't build an image, even if it's missing.
+    --build                Build images before creating containers.
 ```
-
-Creates containers for a service.
diff --git a/docs/reference/up.md b/docs/reference/up.md
@@ -15,22 +15,24 @@ parent = "smn_compose_cli"
 Usage: up [options] [SERVICE...]
 
 Options:
--d                         Detached mode: Run containers in the background,
-                           print new container names.
-                           Incompatible with --abort-on-container-exit.
---no-color                 Produce monochrome output.
---no-deps                  Don't start linked services.
---force-recreate           Recreate containers even if their configuration
-                           and image haven't changed.
-                           Incompatible with --no-recreate.
---no-recreate              If containers already exist, don't recreate them.
-                           Incompatible with --force-recreate.
---no-build                 Don't build an image, even if it's missing
---abort-on-container-exit  Stops all containers if any container was stopped.
-                           Incompatible with -d.
--t, --timeout TIMEOUT      Use this timeout in seconds for container shutdown
-                           when attached or when containers are already
-                           running. (default: 10)
+    -d                         Detached mode: Run containers in the background,
+                               print new container names.
+                               Incompatible with --abort-on-container-exit.
+    --no-color                 Produce monochrome output.
+    --no-deps                  Don't start linked services.
+    --force-recreate           Recreate containers even if their configuration
+                               and image haven't changed.
+                               Incompatible with --no-recreate.
+    --no-recreate              If containers already exist, don't recreate them.
+                               Incompatible with --force-recreate.
+    --no-build                 Don't build an image, even if it's missing.
+    --build                    Build images before starting containers.
+    --abort-on-container-exit  Stops all containers if any container was stopped.
+                               Incompatible with -d.
+    -t, --timeout TIMEOUT      Use this timeout in seconds for container shutdown
+                               when attached or when containers are already
+                               running. (default: 10)
+
 ```
 
 Builds, (re)creates, starts, and attaches to containers for a service.

diff --git a/tests/unit/service_test.py b/tests/unit/service_test.py
@@ -433,7 +433,7 @@ def test_create_container_with_build(self):
             service.create_container(do_build=BuildAction.none)
             assert mock_log.warn.called
             _, args, _ = mock_log.warn.mock_calls[0]
-            assert 'was build because it was not found' in args[0]
+            assert 'was built because it did not already exist' in args[0]
 
         self.mock_client.build.assert_called_once_with(
             tag='default_foo',